cardea.fhir package¶
Submodules¶
cardea.fhir.Account module¶
-
class
cardea.fhir.Account.Account(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
-
resourceType¶ This is a Account resource
-
identifier¶ Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number).
-
status¶ Indicates whether the account is presently used/usable or not.
-
type¶ Categorizes the account for reporting and searching purposes.
-
name¶ Name used for the account when displaying it to humans in reports, etc.
-
subject¶ Identifies the patient, device, practitioner, location or other object the account is associated with.
-
period¶ Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.
-
active¶ Indicates the period of time over which the account is allowed to have transactions posted to it. This period may be different to the coveragePeriod which is the duration of time that services may occur.
-
balance¶ Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.
-
coverage¶ The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.
-
owner¶ Indicates the organization, department, etc. with responsibility for the account.
-
description¶ Provides additional information about what the account tracks and how it is used.
-
guarantor¶ Parties financially responsible for the account.
-
-
class
cardea.fhir.Account.Account_Coverage(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
-
coverage¶ The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay). A coverage may only be resposible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.
-
priority¶ The priority of the coverage in the context of this account.
-
-
class
cardea.fhir.Account.Account_Guarantor(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
-
party¶ The entity who is responsible.
-
onHold¶ A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.
-
period¶ The timeframe during which the guarantor accepts responsibility for the account.
-
cardea.fhir.ActivityDefinition module¶
-
class
cardea.fhir.ActivityDefinition.ActivityDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
-
resourceType¶ This is a ActivityDefinition resource
-
url¶ An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this activity definition is (or will be) published. The URL SHOULD include the major version of the activity definition. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
-
name¶ A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the activity definition.
-
status¶ The status of this activity definition. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the activity definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.
-
publisher¶ The name of the individual or organization that published the activity definition.
-
description¶ A free text natural language description of the activity definition from a consumer’s perspective.
-
purpose¶ Explaination of why this activity definition is needed and why it has been designed as it has.
-
usage¶ A detailed description of how the asset is used from a clinical perspective.
-
approvalDate¶ The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate¶ The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn’t change the original approval date.
-
effectivePeriod¶ The period during which the activity definition content was or is planned to be in active use.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate activity definition instances.
-
jurisdiction¶ A legal or geographic region in which the activity definition is intended to be used.
-
topic¶ Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
-
contributor¶ A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
copyright¶ A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
Related artifacts such as additional documentation, justification, or bibliographic references.
-
library¶ A reference to a Library resource containing any formal logic used by the asset.
-
kind¶ A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
-
code¶ Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
-
timingTiming¶ The period, timing or frequency upon which the described activity is to occur.
-
timingDateTime¶ The period, timing or frequency upon which the described activity is to occur.
-
timingPeriod¶ The period, timing or frequency upon which the described activity is to occur.
-
timingRange¶ The period, timing or frequency upon which the described activity is to occur.
-
location¶ Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
-
participant¶ Indicates who should participate in performing the action described.
-
productReference¶ Identifies the food, drug or other product being consumed or supplied in the activity.
-
productCodeableConcept¶ Identifies the food, drug or other product being consumed or supplied in the activity.
-
quantity¶ Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).
-
dosage¶ Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
-
bodySite¶ Indicates the sites on the subject’s body where the procedure should be performed (I.e. the target sites).
-
transform¶ A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
-
dynamicValue¶ Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient’s weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the intent resource that would contain the result.
-
-
class
cardea.fhir.ActivityDefinition.ActivityDefinition_DynamicValue(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
-
description¶ A brief, natural language description of the intended semantics of the dynamic value.
-
path¶ The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression.
-
language¶ The media type of the language for the expression.
-
expression¶ An expression specifying the value of the customized element.
-
-
class
cardea.fhir.ActivityDefinition.ActivityDefinition_Participant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
-
type¶ The type of participant in the action.
-
role¶ The role the participant should play in performing the described action.
-
cardea.fhir.Address module¶
-
class
cardea.fhir.Address.Address(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
-
use¶ The purpose of this address.
-
type¶ Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
-
text¶ A full text representation of the address.
-
line¶ This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
-
city¶ The name of the city, town, village or other community or delivery center.
-
district¶ The name of the administrative area (county).
-
state¶ Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).
-
postalCode¶ A postal code designating a region defined by the postal service.
-
country¶ Country - a nation as commonly understood or generally accepted.
-
period¶ Time period when address was/is in use.
-
cardea.fhir.AdverseEvent module¶
-
class
cardea.fhir.AdverseEvent.AdverseEvent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseActual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.
-
resourceType¶ This is a AdverseEvent resource
-
identifier¶ The identifier(s) of this adverse event that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itsefl is not appropriate.
-
category¶ The type of event which is important to characterize what occurred and caused harm to the subject, or had the potential to cause harm to the subject.
-
type¶ This element defines the specific type of event that occurred or that was prevented from occurring.
-
subject¶ This subject or group impacted by the event. With a prospective adverse event, there will be no subject as the adverse event was prevented.
-
date¶ The date (and perhaps time) when the adverse event occurred.
-
reaction¶ Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
-
location¶ The information about where the adverse event occurred.
-
seriousness¶ Describes the seriousness or severity of the adverse event.
-
outcome¶ Describes the type of outcome from the adverse event.
-
recorder¶ Information on who recorded the adverse event. May be the patient or a practitioner.
-
eventParticipant¶ Parties that may or should contribute or have contributed information to the Act. Such information includes information leading to the decision to perform the Act and how to perform the Act (e.g. consultant), information that the Act itself seeks to reveal (e.g. informant of clinical history), or information about what Act was performed (e.g. informant witness).
-
description¶ Describes the adverse event in text.
-
suspectEntity¶ Describes the entity that is suspected to have caused the adverse event.
-
subjectMedicalHistory¶ AdverseEvent.subjectMedicalHistory.
-
referenceDocument¶ AdverseEvent.referenceDocument.
-
study¶ AdverseEvent.study.
-
-
class
cardea.fhir.AdverseEvent.AdverseEvent_SuspectEntity(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseActual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.
-
instance¶ Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.
-
causality¶ causality1 | causality2.
-
causalityAssessment¶ assess1 | assess2.
-
causalityProductRelatedness¶ AdverseEvent.suspectEntity.causalityProductRelatedness.
-
causalityMethod¶ method1 | method2.
-
causalityAuthor¶ AdverseEvent.suspectEntity.causalityAuthor.
-
causalityResult¶ result1 | result2.
-
cardea.fhir.Age module¶
-
class
cardea.fhir.Age.Age(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA duration of time during which an organism (or a process) has existed.
cardea.fhir.AllergyIntolerance module¶
-
class
cardea.fhir.AllergyIntolerance.AllergyIntolerance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRisk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
-
resourceType¶ This is a AllergyIntolerance resource
-
identifier¶ This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
clinicalStatus¶ The clinical status of the allergy or intolerance.
-
verificationStatus¶ Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
-
type¶ Identification of the underlying physiological mechanism for the reaction risk.
-
category¶ Category of the identified substance.
-
criticality¶ Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
-
code¶ Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., “Latex”), an allergy or intolerance condition (e.g., “Latex allergy”), or a negated/excluded code for a specific substance or class (e.g., “No latex allergy”) or a general or categorical negated statement (e.g., “No known allergy”, “No known drug allergies”).
-
patient¶ The patient who has the allergy or intolerance.
-
onsetDateTime¶ Estimated or actual date, date-time, or age when allergy or intolerance was identified.
-
onsetAge¶ Estimated or actual date, date-time, or age when allergy or intolerance was identified.
-
onsetPeriod¶ Estimated or actual date, date-time, or age when allergy or intolerance was identified.
-
onsetRange¶ Estimated or actual date, date-time, or age when allergy or intolerance was identified.
-
onsetString¶ Estimated or actual date, date-time, or age when allergy or intolerance was identified.
-
assertedDate¶ The date on which the existance of the AllergyIntolerance was first asserted or acknowledged.
-
recorder¶ Individual who recorded the record and takes responsibility for its content.
-
asserter¶ The source of the information about the allergy that is recorded.
-
lastOccurrence¶ Represents the date and/or time of the last known occurrence of a reaction event.
-
note¶ Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
-
reaction¶ Details about each adverse reaction event linked to exposure to the identified substance.
-
-
class
cardea.fhir.AllergyIntolerance.AllergyIntolerance_Reaction(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRisk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
-
substance¶ Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the ‘code’ and ignore the ‘reaction.substance’.
-
manifestation¶ Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.
-
description¶ Text description about the reaction as a whole, including details of the manifestation if required.
-
onset¶ Record of the date and/or time of the onset of the Reaction.
-
severity¶ Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.
-
exposureRoute¶ Identification of the route by which the subject was exposed to the substance.
-
note¶ Additional text about the adverse reaction event not captured in other fields.
-
cardea.fhir.Annotation module¶
-
class
cardea.fhir.Annotation.Annotation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA text note which also contains information about who made the statement and when.
The individual responsible for making the annotation.
The individual responsible for making the annotation.
-
time¶ Indicates when this particular annotation was made.
-
text¶ The text of the annotation.
cardea.fhir.Appointment module¶
-
class
cardea.fhir.Appointment.Appointment(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
-
resourceType¶ This is a Appointment resource
-
identifier¶ This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
status¶ The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
-
serviceCategory¶ A broad categorisation of the service that is to be performed during this appointment.
-
serviceType¶ The specific service that is to be performed during this appointment.
-
specialty¶ The specialty of a practitioner that would be required to perform the service requested in this appointment.
-
appointmentType¶ The style of appointment or patient that has been booked in the slot (not service type).
-
reason¶ The reason that this appointment is being scheduled. This is more clinical than administrative.
-
indication¶ Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
-
priority¶ The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
-
description¶ The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
-
supportingInformation¶ Additional information to support the appointment provided when making the appointment.
-
start¶ Date/Time that the appointment is to take place.
-
end¶ Date/Time that the appointment is to conclude.
-
minutesDuration¶ Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).
-
slot¶ The slots from the participants’ schedules that will be filled by the appointment.
-
created¶ The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
-
comment¶ Additional comments about the appointment.
-
incomingReferral¶ The referral request this appointment is allocated to assess (incoming referral).
-
participant¶ List of participants involved in the appointment.
-
requestedPeriod¶ A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time.
-
-
class
cardea.fhir.Appointment.Appointment_Participant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
-
type¶ Role of participant in the appointment.
-
actor¶ A Person, Location/HealthcareService or Device that is participating in the appointment.
-
required¶ Is this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.
-
status¶ Participation status of the actor.
-
cardea.fhir.AppointmentResponse module¶
-
class
cardea.fhir.AppointmentResponse.AppointmentResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
-
resourceType¶ This is a AppointmentResponse resource
-
identifier¶ This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.
-
appointment¶ Appointment that this response is replying to.
-
start¶ Date/Time that the appointment is to take place, or requested new start time.
-
end¶ This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
-
participantType¶ Role of participant in the appointment.
-
actor¶ A Person, Location/HealthcareService or Device that is participating in the appointment.
-
participantStatus¶ Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
-
comment¶ Additional comments about the appointment.
-
cardea.fhir.Attachment module¶
-
class
cardea.fhir.Attachment.Attachment(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseFor referring to data content defined in other formats.
-
contentType¶ Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
-
language¶ The human language of the content. The value can be any valid value according to BCP 47.
-
data¶ The actual data of the attachment - a sequence of bytes. In XML, represented using base64.
-
url¶ An alternative location where the data can be accessed.
-
size¶ The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
-
hash¶ The calculated hash of the data using SHA-1. Represented using base64.
-
title¶ A label or set of text to display in place of the data.
-
creation¶ The date that the attachment was first created.
-
cardea.fhir.AuditEvent module¶
-
class
cardea.fhir.AuditEvent.AuditEvent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
-
resourceType¶ This is a AuditEvent resource
-
type¶ Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.
-
subtype¶ Identifier for the category of event.
-
action¶ Indicator for type of action performed during the event that generated the audit.
-
recorded¶ The time when the event occurred on the source.
-
outcome¶ Indicates whether the event succeeded or failed.
-
outcomeDesc¶ A free text description of the outcome of the event.
-
purposeOfEvent¶ The purposeOfUse (reason) that was used during the event being recorded.
-
agent¶ An actor taking an active role in the event or activity that is logged.
-
source¶ The system that is reporting the event.
-
entity¶ Specific instances of data or objects that have been accessed.
-
-
class
cardea.fhir.AuditEvent.AuditEvent_Agent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
-
role¶ The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.
-
reference¶ Direct reference to a resource that identifies the agent.
-
userId¶ Unique identifier for the user actively participating in the event.
-
altId¶ Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.
-
name¶ Human-meaningful name for the agent.
-
requestor¶ Indicator that the user is or is not the requestor, or initiator, for the event being audited.
-
location¶ Where the event occurred.
-
policy¶ The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.
-
media¶ Type of media involved. Used when the event is about exporting/importing onto media.
-
network¶ Logical network location for application activity, if the activity has a network location.
-
purposeOfUse¶ The reason (purpose of use), specific to this agent, that was used during the event being recorded.
-
-
class
cardea.fhir.AuditEvent.AuditEvent_Detail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
-
type¶ The type of extra detail provided in the value.
-
value¶ The details, base64 encoded. Used to carry bulk information.
-
-
class
cardea.fhir.AuditEvent.AuditEvent_Entity(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
-
identifier¶ Identifies a specific instance of the entity. The reference should always be version specific.
-
reference¶ Identifies a specific instance of the entity. The reference should be version specific.
-
type¶ The type of the object that was involved in this audit event.
-
role¶ Code representing the role the entity played in the event being audited.
-
lifecycle¶ Identifier for the data life-cycle stage for the entity.
-
securityLabel¶ Security labels for the identified entity.
-
name¶ A name of the entity in the audit event.
-
description¶ Text that describes the entity in more detail.
-
query¶ The query parameters for a query-type entities.
-
detail¶ Tagged value pairs for conveying additional information about the entity.
-
-
class
cardea.fhir.AuditEvent.AuditEvent_Network(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
-
address¶ An identifier for the network access point of the user device for the audit event.
-
type¶ An identifier for the type of network access point that originated the audit event.
-
-
class
cardea.fhir.AuditEvent.AuditEvent_Source(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
-
site¶ Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.
-
identifier¶ Identifier of the source where the event was detected.
-
type¶ Code specifying the type of source where event originated.
-
cardea.fhir.BackboneElement module¶
-
class
cardea.fhir.BackboneElement.BackboneElement(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseBase definition for all elements that are defined inside a resource - but not those in a data type.
-
modifierExtension¶ May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
-
cardea.fhir.Basic module¶
-
class
cardea.fhir.Basic.Basic(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseBasic is used for handling concepts not yet defined in FHIR, narrative-only resources that don’t map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
-
resourceType¶ This is a Basic resource
-
identifier¶ Identifier assigned to the resource for business purposes, outside the context of FHIR.
-
code¶ Identifies the ‘type’ of resource - equivalent to the resource name for other resources.
-
subject¶ Identifies the patient, practitioner, device or any other resource that is the “focus” of this resource.
-
created¶ Identifies when the resource was first created.
Indicates who was responsible for creating the resource instance.
-
cardea.fhir.Binary module¶
-
class
cardea.fhir.Binary.Binary(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA binary resource can contain any content, whether text, image, pdf, zip archive, etc.
-
resourceType¶ This is a Binary resource
-
contentType¶ MimeType of the binary content represented as a standard MimeType (BCP 13).
-
securityContext¶ Treat this binary as if it was this other resource for access control purposes.
-
content¶ The actual content, base64 encoded.
-
cardea.fhir.BodySite module¶
-
class
cardea.fhir.BodySite.BodySite(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRecord details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.
-
resourceType¶ This is a BodySite resource
-
identifier¶ Identifier for this instance of the anatomical location.
-
active¶ Whether this body site is in active use.
-
code¶ Named anatomical location - ideally coded where possible.
-
qualifier¶ Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.
-
description¶ A summary, charactarization or explanation of the anatomic location.
-
image¶ Image or images used to identify a location.
-
patient¶ The person to which the body site belongs.
-
cardea.fhir.Bundle module¶
-
class
cardea.fhir.Bundle.Bundle(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA container for a collection of resources.
-
resourceType¶ This is a Bundle resource
-
identifier¶ A persistent identifier for the batch that won’t change as a batch is copied from server to server.
-
type¶ Indicates the purpose of this bundle - how it was intended to be used.
-
total¶ If a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle).
-
link¶ A series of links that provide context to this bundle.
-
entry¶ An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
-
signature¶ Digital Signature - base64 encoded. XML-DSIg or a JWT.
-
-
class
cardea.fhir.Bundle.Bundle_Entry(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA container for a collection of resources.
-
link¶ A series of links that provide context to this entry.
-
fullUrl¶ The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: * fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) * Results from operations might involve resources that are not identified.
-
resource¶ The Resources for the entry.
-
search¶ Information about the search process that lead to the creation of this entry.
-
request¶ Additional information about how this entry should be processed as part of a transaction.
-
response¶ Additional information about how this entry should be processed as part of a transaction.
-
-
class
cardea.fhir.Bundle.Bundle_Link(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA container for a collection of resources.
-
relation¶ A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).
-
url¶ The reference details for the link.
-
-
class
cardea.fhir.Bundle.Bundle_Request(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA container for a collection of resources.
-
method¶ The HTTP verb for this entry in either a change history, or a transaction/ transaction response.
-
url¶ The URL for this entry, relative to the root (the address to which the request is posted).
-
ifNoneMatch¶ If the ETag values match, return a 304 Not Modified status. See the API documentation for [“Conditional Read”](http.html#cread).
-
ifModifiedSince¶ Only perform the operation if the last updated date matches. See the API documentation for [“Conditional Read”](http.html#cread).
-
ifMatch¶ Only perform the operation if the Etag value matches. For more information, see the API section [“Managing Resource Contention”](http.html#concurrency).
-
ifNoneExist¶ Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [“Conditional Create”](http.html#ccreate). This is just the query portion of the URL - what follows the “?” (not including the “?”).
-
-
class
cardea.fhir.Bundle.Bundle_Response(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA container for a collection of resources.
-
status¶ The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.
-
location¶ The location header created by processing this operation.
-
etag¶ The etag for the resource, it the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).
-
lastModified¶ The date/time that the resource was modified on the server.
-
outcome¶ An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
-
-
class
cardea.fhir.Bundle.Bundle_Search(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA container for a collection of resources.
-
mode¶ Why this entry is in the result set - whether it’s included as a match or because of an _include requirement.
-
score¶ When searching, the server’s search ranking score for the entry.
-
cardea.fhir.CapabilityStatement module¶
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
resourceType¶ This is a CapabilityStatement resource
-
url¶ An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see [Technical and Business Versions](resource.html#versions).
-
version¶ The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the capability statement.
-
status¶ The status of this capability statement. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the capability statement was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.
-
publisher¶ The name of the individual or organization that published the capability statement.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the capability statement from a consumer’s perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate capability statement instances.
-
jurisdiction¶ A legal or geographic region in which the capability statement is intended to be used.
-
purpose¶ Explaination of why this capability statement is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.
-
kind¶ The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind not instance of software) or a class of implementation (e.g. a desired purchase).
-
instantiates¶ Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do so.
-
software¶ Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
-
implementation¶ Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
-
fhirVersion¶ The version of the FHIR specification on which this capability statement is based.
-
acceptUnknown¶ A code that indicates whether the application accepts unknown elements or extensions when reading resources.
-
format¶ A list of the formats supported by this implementation using their content types.
-
patchFormat¶ A list of the patch formats supported by this implementation using their content types.
-
implementationGuide¶ A list of implementation guides that the server does (or should) support in their entirety.
-
profile¶ A list of profiles that represent different use cases supported by the system. For a server, “supported by the system” means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).
-
rest¶ A definition of the restful capabilities of the solution, if any.
-
messaging¶ A description of the messaging capabilities of the solution.
-
document¶ A document definition.
-
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement_Certificate(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
type¶ Mime type for a certificate.
-
blob¶ Actual certificate.
-
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement_Document(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
mode¶ Mode of this document declaration - whether an application is a producer or consumer.
-
documentation¶ A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc.
-
profile¶ A constraint on a resource used in the document.
-
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement_Endpoint(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
protocol¶ A list of the messaging transport protocol(s) identifiers, supported by this endpoint.
-
address¶ The network address of the end-point. For solutions that do not use network addresses for routing, it can be just an identifier.
-
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement_Event(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
code¶ A coded identifier of a supported messaging event.
-
category¶ The impact of the content of the message.
-
mode¶ The mode of this event declaration - whether an application is a sender or receiver.
-
focus¶ A resource associated with the event. This is the resource that defines the event.
-
request¶ Information about the request for this event.
-
response¶ Information about the response for this event.
-
documentation¶ Guidance on how this event is handled, such as internal system trigger points, business rules, etc.
-
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement_Implementation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
description¶ Information about the specific installation that this capability statement relates to.
-
url¶ An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.
-
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement_Interaction(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
code¶ Coded identifier of the operation, supported by the system resource.
-
documentation¶ Guidance specific to the implementation of this operation, such as ‘delete is a logical delete’ or ‘updates are only allowed with version id’ or ‘creates permitted from pre-authorized certificates only’.
-
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement_Interaction1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
code¶ A coded identifier of the operation, supported by the system.
-
documentation¶ Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.
-
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement_Messaging(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
endpoint¶ An endpoint (network accessible address) to which messages and/or replies are to be sent.
-
reliableCache¶ Length if the receiver’s reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).
-
documentation¶ Documentation about the system’s messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.
-
supportedMessage¶ References to message definitions for messages this system can send or receive.
-
event¶ A description of the solution’s support for an event at this end-point.
-
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement_Operation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
name¶ The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.
-
definition¶ Where the formal definition can be found.
-
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement_Resource(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
type¶ A type of resource exposed via the restful interface.
-
profile¶ A specification of the profile that describes the solution’s overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses).
-
documentation¶ Additional information about the resource type used by the system.
-
interaction¶ Identifies a restful operation supported by the solution.
-
versioning¶ This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is ‘versioned-update’, then the server supports all the versioning features, including using e-tags for version integrity in the API.
-
readHistory¶ A flag for whether the server is able to return past versions as part of the vRead operation.
-
updateCreate¶ A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.
-
conditionalCreate¶ A flag that indicates that the server supports conditional create.
-
conditionalRead¶ A code that indicates how the server supports conditional read.
-
conditionalUpdate¶ A flag that indicates that the server supports conditional update.
-
conditionalDelete¶ A code that indicates how the server supports conditional delete.
-
referencePolicy¶ A set of flags that defines how references are supported.
-
searchInclude¶ A list of _include values supported by the server.
-
searchRevInclude¶ A list of _revinclude (reverse include) values supported by the server.
-
searchParam¶ Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
-
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement_Rest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
mode¶ Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.
-
documentation¶ Information about the system’s restful capabilities that apply across all applications, such as security.
-
security¶ Information about security implementation from an interface perspective - what a client needs to know.
-
resource¶ A specification of the restful capabilities of the solution for a specific resource type.
-
interaction¶ A specification of restful operations supported by the system.
-
searchParam¶ Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
-
operation¶ Definition of an operation or a named query together with its parameters and their meaning and type.
-
compartment¶ An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .
-
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement_SearchParam(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
name¶ The name of the search parameter used in the interface.
-
definition¶ An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]).
-
type¶ The type of value a search parameter refers to, and how the content is interpreted.
-
documentation¶ This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.
-
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement_Security(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
cors¶ Server adds CORS headers when responding to requests - this enables javascript applications to use the server.
-
service¶ Types of security services that are supported/required by the system.
-
description¶ General description of how security works.
-
certificate¶ Certificates associated with security profiles.
-
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement_Software(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
name¶ Name software is known by.
-
version¶ The version identifier for the software covered by this statement.
-
releaseDate¶ Date this version of the software was released.
-
-
class
cardea.fhir.CapabilityStatement.CapabilityStatement_SupportedMessage(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
mode¶ The mode of this event declaration - whether application is sender or receiver.
-
definition¶ Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.
-
cardea.fhir.CarePlan module¶
-
class
cardea.fhir.CarePlan.CarePlan(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
-
resourceType¶ This is a CarePlan resource
-
identifier¶ This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
definition¶ Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.
-
basedOn¶ A care plan that is fulfilled in whole or in part by this care plan.
-
replaces¶ Completed or terminated care plan whose function is taken by this new care plan.
-
partOf¶ A larger care plan of which this particular care plan is a component or step.
-
status¶ Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
-
intent¶ Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
-
category¶ Identifies what “kind” of plan this is to support differentiation between multiple co-existing plans; e.g. “Home health”, “psychiatric”, “asthma”, “disease management”, “wellness plan”, etc.
-
title¶ Human-friendly name for the CarePlan.
-
description¶ A description of the scope and nature of the plan.
-
subject¶ Identifies the patient or group whose intended care is described by the plan.
-
context¶ Identifies the original context in which this particular CarePlan was created.
-
period¶ Indicates when the plan did (or is intended to) come into effect and end.
Identifies the individual(s) or ogranization who is responsible for the content of the care plan.
-
careTeam¶ Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
-
addresses¶ Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
-
supportingInfo¶ Identifies portions of the patient’s record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.
-
goal¶ Describes the intended objective(s) of carrying out the care plan.
-
activity¶ Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
-
note¶ General notes about the care plan not covered elsewhere.
-
-
class
cardea.fhir.CarePlan.CarePlan_Activity(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
-
outcomeCodeableConcept¶ Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).
-
outcomeReference¶ Details of the outcome or action resulting from the activity. The reference to an “event” resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).
-
progress¶ Notes about the adherence/status/progress of the activity.
-
reference¶ The details of the proposed activity represented in a specific resource.
-
detail¶ A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn’t know about specific resources such as procedure etc.
-
-
class
cardea.fhir.CarePlan.CarePlan_Detail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
-
category¶ High-level categorization of the type of activity in a care plan.
-
definition¶ Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.
-
code¶ Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.
-
reasonCode¶ Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.
-
reasonReference¶ Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.
-
goal¶ Internal reference that identifies the goals that this activity is intended to contribute towards meeting.
-
status¶ Identifies what progress is being made for the specific activity.
-
statusReason¶ Provides reason why the activity isn’t yet started, is on hold, was cancelled, etc.
-
prohibited¶ If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, indicates that the described activity is one that should be engaged in when following the plan.
-
scheduledTiming¶ The period, timing or frequency upon which the described activity is to occur.
-
scheduledPeriod¶ The period, timing or frequency upon which the described activity is to occur.
-
scheduledString¶ The period, timing or frequency upon which the described activity is to occur.
-
location¶ Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
-
performer¶ Identifies who’s expected to be involved in the activity.
-
productCodeableConcept¶ Identifies the food, drug or other product to be consumed or supplied in the activity.
-
productReference¶ Identifies the food, drug or other product to be consumed or supplied in the activity.
-
dailyAmount¶ Identifies the quantity expected to be consumed in a given day.
-
quantity¶ Identifies the quantity expected to be supplied, administered or consumed by the subject.
-
description¶ This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.
-
cardea.fhir.CareTeam module¶
-
class
cardea.fhir.CareTeam.CareTeam(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
-
resourceType¶ This is a CareTeam resource
-
identifier¶ This records identifiers associated with this care team that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.
-
status¶ Indicates the current state of the care team.
-
category¶ Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.
-
name¶ A label for human use intended to distinguish like teams. E.g. the “red” vs. “green” trauma teams.
-
subject¶ Identifies the patient or group whose intended care is handled by the team.
-
context¶ The encounter or episode of care that establishes the context for this care team.
-
period¶ Indicates when the team did (or is intended to) come into effect and end.
-
participant¶ Identifies all people and organizations who are expected to be involved in the care team.
-
reasonCode¶ Describes why the care team exists.
-
reasonReference¶ Condition(s) that this care team addresses.
-
managingOrganization¶ The organization responsible for the care team.
-
note¶ Comments made about the CareTeam.
-
-
class
cardea.fhir.CareTeam.CareTeam_Participant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
-
role¶ Indicates specific responsibility of an individual within the care team, such as “Primary care physician”, “Trained social worker counselor”, “Caregiver”, etc.
-
member¶ The specific person or organization who is participating/expected to participate in the care team.
-
onBehalfOf¶ The organization of the practitioner.
-
period¶ Indicates when the specific member or organization did (or is intended to) come into effect and end.
-
cardea.fhir.ChargeItem module¶
-
class
cardea.fhir.ChargeItem.ChargeItem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.
-
resourceType¶ This is a ChargeItem resource
-
identifier¶ Identifiers assigned to this event performer or other systems.
-
definition¶ References the source of pricing information, rules of application for the code this ChargeItem uses.
-
status¶ The current state of the ChargeItem.
-
partOf¶ ChargeItems can be grouped to larger ChargeItems covering the whole set.
-
code¶ A code that identifies the charge, like a billing code.
-
subject¶ The individual or set of individuals the action is being or was performed on.
-
context¶ The encounter or episode of care that establishes the context for this event.
-
occurrenceDateTime¶ Date/time(s) or duration when the charged service was applied.
-
occurrencePeriod¶ Date/time(s) or duration when the charged service was applied.
-
occurrenceTiming¶ Date/time(s) or duration when the charged service was applied.
-
participant¶ Indicates who or what performed or participated in the charged service.
-
performingOrganization¶ The organization requesting the service.
-
requestingOrganization¶ The organization performing the service.
-
quantity¶ Quantity of which the charge item has been serviced.
-
bodysite¶ The anatomical location where the related service has been applied.
-
factorOverride¶ Factor overriding the factor determined by the rules associated with the code.
-
priceOverride¶ Total price of the charge overriding the list price associated with the code.
-
overrideReason¶ If the list price or the rule based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.
-
enterer¶ The device, practitioner, etc. who entered the charge item.
-
enteredDate¶ Date the charge item was entered.
-
reason¶ Describes why the event occurred in coded or textual form.
-
service¶ Indicated the rendered service that caused this charge.
-
account¶ Account into which this ChargeItems belongs.
-
note¶ Comments made about the event by the performer, subject or other participants.
-
supportingInformation¶ Further information supporting the this charge.
-
-
class
cardea.fhir.ChargeItem.ChargeItem_Participant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.
-
role¶ Describes the type of performance or participation(e.g. primary surgeon, anaesthesiologiest, etc.).
-
actor¶ The device, practitioner, etc. who performed or participated in the service.
-
cardea.fhir.Claim module¶
-
class
cardea.fhir.Claim.Claim(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
resourceType¶ This is a Claim resource
-
identifier¶ The business identifier for the instance: claim number, pre-determination or pre-authorization number.
-
status¶ The status of the resource instance.
-
type¶ The category of claim, eg, oral, pharmacy, vision, insitutional, professional.
-
subType¶ A finer grained suite of claim subtype codes which may convey Inpatient vs Outpatient and/or a specialty service. In the US the BillType.
-
use¶ Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination).
-
patient¶ Patient Resource.
-
billablePeriod¶ The billable period for which charges are being submitted.
-
created¶ The date when the enclosed suite of services were performed or completed.
-
enterer¶ Person who created the invoice/claim/pre-determination or pre-authorization.
-
insurer¶ The Insurer who is target of the request.
-
provider¶ The provider which is responsible for the bill, claim pre-determination, pre-authorization.
-
organization¶ The organization which is responsible for the bill, claim pre-determination, pre-authorization.
-
priority¶ Immediate (STAT), best effort (NORMAL), deferred (DEFER).
-
fundsReserve¶ In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved (‘Patient’ or ‘Provider’) to pay for the Benefits determined on the subsequent claim(s). ‘None’ explicitly indicates no funds reserving is requested.
Other claims which are related to this claim such as prior claim versions or for related services.
-
prescription¶ Prescription to support the dispensing of Pharmacy or Vision products.
-
originalPrescription¶ Original prescription which has been superceded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new precription for an alternate medication which has the same theraputic intent. The prescription from the pharmacy becomes the ‘prescription’ and that from the physician becomes the ‘original prescription’.
-
payee¶ The party to be reimbursed for the services.
-
referral¶ The referral resource which lists the date, practitioner, reason and other supporting information.
-
facility¶ Facility where the services were provided.
-
careTeam¶ The members of the team who provided the overall service as well as their role and whether responsible and qualifications.
-
information¶ Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are mutiple jurisdiction specific valuesets which are required.
-
diagnosis¶ List of patient diagnosis for which care is sought.
-
procedure¶ Ordered list of patient procedures performed to support the adjudication.
-
insurance¶ Financial instrument by which payment information for health care.
-
accident¶ An accident which resulted in the need for healthcare services.
-
employmentImpacted¶ The start and optional end dates of when the patient was precluded from working due to the treatable condition(s).
-
hospitalization¶ The start and optional end dates of when the patient was confined to a treatment center.
-
item¶ First tier of goods and services.
-
total¶ The total value of the claim.
-
-
class
cardea.fhir.Claim.Claim_Accident(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
date¶ Date of an accident which these services are addressing.
-
type¶ Type of accident: work, auto, etc.
-
locationAddress¶ Accident Place.
-
locationReference¶ Accident Place.
-
-
class
cardea.fhir.Claim.Claim_CareTeam(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ Sequence of the careTeam which serves to order and provide a link.
-
provider¶ Member of the team who provided the overall service.
-
responsible¶ The party who is billing and responsible for the claimed good or service rendered to the patient.
-
role¶ The lead, assisting or supervising practitioner and their discipline if a multidisiplinary team.
-
qualification¶ The qualification which is applicable for this service.
-
-
class
cardea.fhir.Claim.Claim_Detail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ A service line number.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. ‘glasses’ or ‘compound’.
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
programCode¶ For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.
-
quantity¶ The number of repetitions of a service or product.
-
unitPrice¶ If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.
-
factor¶ A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
net¶ The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
udi¶ List of Unique Device Identifiers associated with this line item.
-
subDetail¶ Third tier of goods and services.
-
-
class
cardea.fhir.Claim.Claim_Diagnosis(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ Sequence of diagnosis which serves to provide a link.
-
diagnosisCodeableConcept¶ The diagnosis.
-
diagnosisReference¶ The diagnosis.
-
type¶ The type of the Diagnosis, for example: admitting, primary, secondary, discharge.
-
packageCode¶ The package billing code, for example DRG, based on the assigned grouping code system.
-
-
class
cardea.fhir.Claim.Claim_Information(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ Sequence of the information element which serves to provide a link.
-
category¶ The general class of the information supplied: information; exception; accident, employment; onset, etc.
-
code¶ System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought which may influence the adjudication.
-
timingDate¶ The date when or period to which this information refers.
-
timingPeriod¶ The date when or period to which this information refers.
-
valueString¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
valueQuantity¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
valueAttachment¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
valueReference¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
reason¶ For example, provides the reason for: the additional stay, or missing tooth or any other situation where a reason code is required in addition to the content.
-
-
class
cardea.fhir.Claim.Claim_Insurance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ Sequence of coverage which serves to provide a link and convey coordination of benefit order.
-
focal¶ A flag to indicate that this Coverage is the focus for adjudication. The Coverage against which the claim is to be adjudicated.
-
coverage¶ Reference to the program or plan identification, underwriter or payor.
-
businessArrangement¶ The contract number of a business agreement which describes the terms and conditions.
-
preAuthRef¶ A list of references from the Insurer to which these services pertain.
-
claimResponse¶ The Coverages adjudication details.
-
-
class
cardea.fhir.Claim.Claim_Item(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ A service line number.
-
careTeamLinkId¶ CareTeam applicable for this service or product line.
-
diagnosisLinkId¶ Diagnosis applicable for this service or product line.
-
procedureLinkId¶ Procedures applicable for this service or product line.
-
informationLinkId¶ Exceptions, special conditions and supporting information pplicable for this service or product line.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,RXNorm,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. ‘glasses’ or ‘compound’.
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
programCode¶ For programs which require reason codes for the inclusion or covering of this billed item under the program or sub-program.
-
servicedDate¶ The date or dates when the enclosed suite of services were performed or completed.
-
servicedPeriod¶ The date or dates when the enclosed suite of services were performed or completed.
-
locationCodeableConcept¶ Where the service was provided.
-
locationAddress¶ Where the service was provided.
-
locationReference¶ Where the service was provided.
-
quantity¶ The number of repetitions of a service or product.
-
unitPrice¶ If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.
-
factor¶ A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
net¶ The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
udi¶ List of Unique Device Identifiers associated with this line item.
-
bodySite¶ Physical service site on the patient (limb, tooth, etc).
-
subSite¶ A region or surface of the site, eg. limb region or tooth surface(s).
-
encounter¶ A billed item may include goods or services provided in multiple encounters.
-
detail¶ Second tier of goods and services.
-
-
class
cardea.fhir.Claim.Claim_Payee(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
type¶ Type of Party to be reimbursed: Subscriber, provider, other.
-
resourceType¶ organization | patient | practitioner | relatedperson.
-
party¶ Party to be reimbursed: Subscriber, provider, other.
-
-
class
cardea.fhir.Claim.Claim_Procedure(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ Sequence of procedures which serves to order and provide a link.
-
date¶ Date and optionally time the procedure was performed .
-
procedureCodeableConcept¶ The procedure code.
-
procedureReference¶ The procedure code.
-
-
class
cardea.fhir.Claim.Claim_Related(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
claim¶ Other claims which are related to this claim such as prior claim versions or for related services.
-
relationship¶ For example prior or umbrella.
-
reference¶ An alternate organizational reference to the case or file to which this particular claim pertains - eg Property/Casualy insurer claim # or Workers Compensation case # .
-
-
class
cardea.fhir.Claim.Claim_SubDetail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ A service line number.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI).
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
programCode¶ For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.
-
quantity¶ The number of repetitions of a service or product.
-
unitPrice¶ The fee for an addittional service or product or charge.
-
factor¶ A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
net¶ The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
udi¶ List of Unique Device Identifiers associated with this line item.
-
cardea.fhir.ClaimResponse module¶
-
class
cardea.fhir.ClaimResponse.ClaimResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
resourceType¶ This is a ClaimResponse resource
-
identifier¶ The Response business identifier.
-
status¶ The status of the resource instance.
-
patient¶ Patient Resource.
-
created¶ The date when the enclosed suite of services were performed or completed.
-
insurer¶ The Insurer who produced this adjudicated response.
-
requestProvider¶ The practitioner who is responsible for the services rendered to the patient.
-
requestOrganization¶ The organization which is responsible for the services rendered to the patient.
-
request¶ Original request resource referrence.
-
outcome¶ Processing outcome errror, partial or complete processing.
-
disposition¶ A description of the status of the adjudication.
-
payeeType¶ Party to be reimbursed: Subscriber, provider, other.
-
item¶ The first tier service adjudications for submitted services.
-
addItem¶ The first tier service adjudications for payor added services.
-
error¶ Mutually exclusive with Services Provided (Item).
-
totalCost¶ The total cost of the services reported.
-
unallocDeductable¶ The amount of deductible applied which was not allocated to any particular service line.
-
totalBenefit¶ Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible).
-
payment¶ Payment details for the claim if the claim has been paid.
-
reserved¶ Status of funds reservation (For provider, for Patient, None).
-
form¶ The form to be used for printing the content.
-
processNote¶ Note text.
-
communicationRequest¶ Request for additional supporting or authorizing information, such as: documents, images or resources.
-
insurance¶ Financial instrument by which payment information for health care.
-
-
class
cardea.fhir.ClaimResponse.ClaimResponse_AddItem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
sequenceLinkId¶ List of input service items which this service line is intended to replace.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ A code to indicate the Professional Service or Product supplied.
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
fee¶ The fee charged for the professional service or product..
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
detail¶ The second tier service adjudications for payor added services.
-
-
class
cardea.fhir.ClaimResponse.ClaimResponse_Adjudication(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
category¶ Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc.
-
reason¶ Adjudication reason such as limit reached.
-
amount¶ Monetary amount associated with the code.
-
value¶ A non-monetary value for example a percentage. Mutually exclusive to the amount element above.
-
-
class
cardea.fhir.ClaimResponse.ClaimResponse_Detail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
sequenceLinkId¶ A service line number.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
subDetail¶ The third tier service adjudications for submitted services.
-
-
class
cardea.fhir.ClaimResponse.ClaimResponse_Detail1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ A code to indicate the Professional Service or Product supplied.
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
fee¶ The fee charged for the professional service or product..
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
-
class
cardea.fhir.ClaimResponse.ClaimResponse_Error(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
sequenceLinkId¶ The sequence number of the line item submitted which contains the error. This value is omitted when the error is elsewhere.
-
detailSequenceLinkId¶ The sequence number of the addition within the line item submitted which contains the error. This value is omitted when the error is not related to an Addition.
-
subdetailSequenceLinkId¶ The sequence number of the addition within the line item submitted which contains the error. This value is omitted when the error is not related to an Addition.
-
code¶ An error code,from a specified code system, which details why the claim could not be adjudicated.
-
-
class
cardea.fhir.ClaimResponse.ClaimResponse_Insurance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
sequence¶ A service line item.
-
focal¶ The instance number of the Coverage which is the focus for adjudication. The Coverage against which the claim is to be adjudicated.
-
coverage¶ Reference to the program or plan identification, underwriter or payor.
-
businessArrangement¶ The contract number of a business agreement which describes the terms and conditions.
-
preAuthRef¶ A list of references from the Insurer to which these services pertain.
-
claimResponse¶ The Coverages adjudication details.
-
-
class
cardea.fhir.ClaimResponse.ClaimResponse_Item(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
sequenceLinkId¶ A service line number.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudication results.
-
detail¶ The second tier service adjudications for submitted services.
-
-
class
cardea.fhir.ClaimResponse.ClaimResponse_Payment(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
type¶ Whether this represents partial or complete payment of the claim.
-
adjustment¶ Adjustment to the payment of this transaction which is not related to adjudication of this transaction.
-
adjustmentReason¶ Reason for the payment adjustment.
-
date¶ Estimated payment data.
-
amount¶ Payable less any payment adjustment.
-
identifier¶ Payment identifier.
-
-
class
cardea.fhir.ClaimResponse.ClaimResponse_ProcessNote(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
number¶ An integer associated with each note which may be referred to from each service line item.
-
type¶ The note purpose: Print/Display.
-
text¶ The note text.
-
language¶ The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. “en” for English, or “en-US” for American English versus “en-EN” for England English.
-
-
class
cardea.fhir.ClaimResponse.ClaimResponse_SubDetail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
sequenceLinkId¶ A service line number.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
cardea.fhir.ClinicalImpression module¶
-
class
cardea.fhir.ClinicalImpression.ClinicalImpression(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient’s condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called “ClinicalImpression” rather than “ClinicalAssessment” to avoid confusion with the recording of assessment tools such as Apgar score.
-
resourceType¶ This is a ClinicalImpression resource
-
identifier¶ A unique identifier assigned to the clinical impression that remains consistent regardless of what server the impression is stored on.
-
status¶ Identifies the workflow status of the assessment.
-
code¶ Categorizes the type of clinical assessment performed.
-
description¶ A summary of the context and/or cause of the assessment - why / where was it performed, and what patient events/status prompted it.
-
subject¶ The patient or group of individuals assessed as part of this record.
-
context¶ The encounter or episode of care this impression was created as part of.
-
effectiveDateTime¶ The point in time or period over which the subject was assessed.
-
effectivePeriod¶ The point in time or period over which the subject was assessed.
-
date¶ Indicates when the documentation of the assessment was complete.
-
assessor¶ The clinician performing the assessment.
-
previous¶ A reference to the last assesment that was conducted bon this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient’s conditions changes.
-
problem¶ This a list of the relevant problems/conditions for a patient.
-
investigation¶ One or more sets of investigations (signs, symptions, etc.). The actual grouping of investigations vary greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.
-
protocol¶ Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.
-
summary¶ A text summary of the investigations and the diagnosis.
-
finding¶ Specific findings or diagnoses that was considered likely or relevant to ongoing treatment.
-
prognosisCodeableConcept¶ Estimate of likely outcome.
-
prognosisReference¶ RiskAssessment expressing likely outcome.
-
action¶ Action taken as part of assessment procedure.
-
note¶ Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.
-
-
class
cardea.fhir.ClinicalImpression.ClinicalImpression_Finding(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient’s condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called “ClinicalImpression” rather than “ClinicalAssessment” to avoid confusion with the recording of assessment tools such as Apgar score.
-
itemCodeableConcept¶ Specific text, code or reference for finding or diagnosis, which may include ruled-out or resolved conditions.
-
itemReference¶ Specific text, code or reference for finding or diagnosis, which may include ruled-out or resolved conditions.
-
basis¶ Which investigations support finding or diagnosis.
-
-
class
cardea.fhir.ClinicalImpression.ClinicalImpression_Investigation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient’s condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called “ClinicalImpression” rather than “ClinicalAssessment” to avoid confusion with the recording of assessment tools such as Apgar score.
-
code¶ A name/code for the group (“set”) of investigations. Typically, this will be something like “signs”, “symptoms”, “clinical”, “diagnostic”, but the list is not constrained, and others such groups such as (exposure|family|travel|nutitirional) history may be used.
-
item¶ A record of a specific investigation that was undertaken.
-
cardea.fhir.CodeSystem module¶
-
class
cardea.fhir.CodeSystem.CodeSystem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA code system resource specifies a set of codes drawn from one or more code systems.
-
resourceType¶ This is a CodeSystem resource
-
url¶ An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this code system is (or will be) published. The URL SHOULD include the major version of the code system. For more information see [Technical and Business Versions](resource.html#versions). This is used in [Coding]{datatypes.html#Coding}.system.
-
identifier¶ A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding]{datatypes.html#Coding}.version.
-
name¶ A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the code system.
-
status¶ The status of this code system. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the code system was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes.
-
publisher¶ The name of the individual or organization that published the code system.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the code system from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate code system instances.
-
jurisdiction¶ A legal or geographic region in which the code system is intended to be used.
-
purpose¶ Explaination of why this code system is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.
-
caseSensitive¶ If code comparison is case sensitive when codes within this system are compared to each other.
-
valueSet¶ Canonical URL of value set that contains the entire code system.
-
hierarchyMeaning¶ The meaning of the hierarchy of concepts.
-
compositional¶ True If code system defines a post-composition grammar.
-
versionNeeded¶ This flag is used to signify that the code system has not (or does not) maintain the definitions, and a version must be specified when referencing this code system.
-
content¶ How much of the content of the code system - the concepts and codes it defines - are represented in this resource.
-
count¶ The total number of concepts defined by the code system. Where the code system has a compositional grammar, the count refers to the number of base (primitive) concepts.
-
filter¶ A filter that can be used in a value set compose statement when selecting concepts using a filter.
-
property¶ A property defines an additional slot through which additional information can be provided about a concept.
-
concept¶ Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meaning of the hierarchical relationships are.
-
-
class
cardea.fhir.CodeSystem.CodeSystem_Concept(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA code system resource specifies a set of codes drawn from one or more code systems.
-
code¶ A code - a text symbol - that uniquely identifies the concept within the code system.
-
display¶ A human readable string that is the recommended default way to present this concept to a user.
-
definition¶ The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.
-
designation¶ Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.
-
property¶ A property value for this concept.
-
concept¶ Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.
-
-
class
cardea.fhir.CodeSystem.CodeSystem_Designation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA code system resource specifies a set of codes drawn from one or more code systems.
-
language¶ The language this designation is defined for.
-
use¶ A code that details how this designation would be used.
-
value¶ The text value for this designation.
-
-
class
cardea.fhir.CodeSystem.CodeSystem_Filter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA code system resource specifies a set of codes drawn from one or more code systems.
-
code¶ The code that identifies this filter when it is used in the instance.
-
description¶ A description of how or why the filter is used.
-
operator¶ A list of operators that can be used with the filter.
-
value¶ A description of what the value for the filter should be.
-
-
class
cardea.fhir.CodeSystem.CodeSystem_Property(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA code system resource specifies a set of codes drawn from one or more code systems.
-
code¶ A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.
-
uri¶ Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.
-
description¶ A description of the property- why it is defined, and how its value might be used.
-
type¶ The type of the property value. Properties of type “code” contain a code defined by the code system (e.g. a reference to anotherr defined concept).
-
-
class
cardea.fhir.CodeSystem.CodeSystem_Property1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA code system resource specifies a set of codes drawn from one or more code systems.
-
code¶ A code that is a reference to CodeSystem.property.code.
-
valueCode¶ The value of this property.
-
valueCoding¶ The value of this property.
-
valueString¶ The value of this property.
-
valueInteger¶ The value of this property.
-
valueBoolean¶ The value of this property.
-
valueDateTime¶ The value of this property.
-
cardea.fhir.CodeableConcept module¶
-
class
cardea.fhir.CodeableConcept.CodeableConcept(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
coding¶ A reference to a code defined by a terminology system.
-
text¶ A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
-
cardea.fhir.Coding module¶
-
class
cardea.fhir.Coding.Coding(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reference to a code defined by a terminology system.
-
system¶ The identification of the code system that defines the meaning of the symbol in the code.
-
version¶ The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
-
code¶ A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
-
display¶ A representation of the meaning of the code in the system, following the rules of the system.
-
userSelected¶ Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
-
cardea.fhir.Communication module¶
-
class
cardea.fhir.Communication.Communication(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.
-
resourceType¶ This is a Communication resource
-
identifier¶ Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
definition¶ A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.
-
basedOn¶ An order, proposal or plan fulfilled in whole or in part by this Communication.
-
partOf¶ Part of this action.
-
status¶ The status of the transmission.
-
notDone¶ If true, indicates that the described communication event did not actually occur.
-
notDoneReason¶ Describes why the communication event did not occur in coded and/or textual form.
-
category¶ The type of message conveyed such as alert, notification, reminder, instruction, etc.
-
medium¶ A channel that was used for this communication (e.g. email, fax).
-
subject¶ The patient or group that was the focus of this communication.
-
recipient¶ The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).
-
topic¶ The resources which were responsible for or related to producing this communication.
-
context¶ The encounter within which the communication was sent.
-
sent¶ The time when this communication was sent.
-
received¶ The time when this communication arrived at the destination.
-
sender¶ The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
-
reasonCode¶ The reason or justification for the communication.
-
reasonReference¶ Indicates another resource whose existence justifies this communication.
-
payload¶ Text, attachment(s), or resource(s) that was communicated to the recipient.
-
note¶ Additional notes or commentary about the communication by the sender, receiver or other interested parties.
-
-
class
cardea.fhir.Communication.Communication_Payload(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.
-
contentString¶ A communicated content (or for multi-part communications, one portion of the communication).
-
contentAttachment¶ A communicated content (or for multi-part communications, one portion of the communication).
-
contentReference¶ A communicated content (or for multi-part communications, one portion of the communication).
-
cardea.fhir.CommunicationRequest module¶
-
class
cardea.fhir.CommunicationRequest.CommunicationRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
-
resourceType¶ This is a CommunicationRequest resource
-
identifier¶ A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.
-
basedOn¶ A plan or proposal that is fulfilled in whole or in part by this request.
-
replaces¶ Completed or terminated request(s) whose function is taken by this new request.
-
groupIdentifier¶ A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
-
status¶ The status of the proposal or order.
-
category¶ The type of message to be sent such as alert, notification, reminder, instruction, etc.
-
priority¶ Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
-
medium¶ A channel that was used for this communication (e.g. email, fax).
-
subject¶ The patient or group that is the focus of this communication request.
-
recipient¶ The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
-
topic¶ The resources which were related to producing this communication request.
-
context¶ The encounter or episode of care within which the communication request was created.
-
payload¶ Text, attachment(s), or resource(s) to be communicated to the recipient.
-
occurrenceDateTime¶ The time when this communication is to occur.
-
occurrencePeriod¶ The time when this communication is to occur.
For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
-
sender¶ The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
-
requester¶ The individual who initiated the request and has responsibility for its activation.
-
reasonCode¶ Describes why the request is being made in coded or textual form.
-
reasonReference¶ Indicates another resource whose existence justifies this request.
-
note¶ Comments made about the request by the requester, sender, recipient, subject or other participants.
-
-
class
cardea.fhir.CommunicationRequest.CommunicationRequest_Payload(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
-
contentString¶ The communicated content (or for multi-part communications, one portion of the communication).
-
contentAttachment¶ The communicated content (or for multi-part communications, one portion of the communication).
-
contentReference¶ The communicated content (or for multi-part communications, one portion of the communication).
-
-
class
cardea.fhir.CommunicationRequest.CommunicationRequest_Requester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
-
agent¶ The device, practitioner, etc. who initiated the request.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
cardea.fhir.CompartmentDefinition module¶
-
class
cardea.fhir.CompartmentDefinition.CompartmentDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA compartment definition that defines how resources are accessed on a server.
-
resourceType¶ This is a CompartmentDefinition resource
-
url¶ An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this compartment definition is (or will be) published. The URL SHOULD include the major version of the compartment definition. For more information see [Technical and Business Versions](resource.html#versions).
-
name¶ A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the compartment definition.
-
status¶ The status of this compartment definition. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the compartment definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.
-
publisher¶ The name of the individual or organization that published the compartment definition.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the compartment definition from a consumer’s perspective.
-
purpose¶ Explaination of why this compartment definition is needed and why it has been designed as it has.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate compartment definition instances.
-
jurisdiction¶ A legal or geographic region in which the compartment definition is intended to be used.
-
code¶ Which compartment this definition describes.
-
search¶ Whether the search syntax is supported,.
-
resource¶ Information about how a resource is related to the compartment.
-
-
class
cardea.fhir.CompartmentDefinition.CompartmentDefinition_Resource(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA compartment definition that defines how resources are accessed on a server.
-
code¶ The name of a resource supported by the server.
-
param¶ The name of a search parameter that represents the link to the compartment. More than one may be listed because a resource may be linked to a compartment in more than one way,.
-
documentation¶ Additional documentation about the resource and compartment.
-
cardea.fhir.Composition module¶
-
class
cardea.fhir.Composition.Composition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.
-
resourceType¶ This is a Composition resource
-
identifier¶ Logical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.
-
status¶ The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
-
type¶ Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
-
class¶ A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.
-
subject¶ Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).
-
encounter¶ Describes the clinical encounter or type of care this documentation is associated with.
-
date¶ The composition editing time, when the composition was last logically changed by the author.
Identifies who is responsible for the information in the composition, not necessarily who typed it in.
-
title¶ Official human-readable label for the composition.
-
confidentiality¶ The code specifying the level of confidentiality of the Composition.
-
attester¶ A participant who has attested to the accuracy of the composition/document.
-
custodian¶ Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
-
relatesTo¶ Relationships that this composition has with other compositions or documents that already exist.
-
event¶ The clinical service, such as a colonoscopy or an appendectomy, being documented.
-
section¶ The root of the sections that make up the composition.
-
-
class
cardea.fhir.Composition.Composition_Attester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.
-
mode¶ The type of attestation the authenticator offers.
-
time¶ When the composition was attested by the party.
-
party¶ Who attested the composition in the specified way.
-
-
class
cardea.fhir.Composition.Composition_Event(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.
-
code¶ This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a “History and Physical Report” in which the procedure being documented is necessarily a “History and Physical” act.
-
period¶ The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.
-
detail¶ The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.
-
-
class
cardea.fhir.Composition.Composition_RelatesTo(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.
-
code¶ The type of relationship that this composition has with anther composition or document.
-
targetIdentifier¶ The target composition/document of this relationship.
-
targetReference¶ The target composition/document of this relationship.
-
-
class
cardea.fhir.Composition.Composition_Section(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.
-
title¶ The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
-
code¶ A code identifying the kind of content contained within the section. This must be consistent with the section title.
-
text¶ A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it “clinically safe” for a human to just read the narrative.
-
mode¶ How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
-
orderedBy¶ Specifies the order applied to the items in the section entries.
-
entry¶ A reference to the actual resource from which the narrative in the section is derived.
-
emptyReason¶ If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
-
section¶ A nested sub-section within this section.
-
cardea.fhir.ConceptMap module¶
-
class
cardea.fhir.ConceptMap.ConceptMap(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.
-
resourceType¶ This is a ConceptMap resource
-
url¶ An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published. The URL SHOULD include the major version of the concept map. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the concept map.
-
status¶ The status of this concept map. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the concept map was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes.
-
publisher¶ The name of the individual or organization that published the concept map.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the concept map from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate concept map instances.
-
jurisdiction¶ A legal or geographic region in which the concept map is intended to be used.
-
purpose¶ Explaination of why this concept map is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.
-
sourceUri¶ The source value set that specifies the concepts that are being mapped.
-
sourceReference¶ The source value set that specifies the concepts that are being mapped.
-
targetUri¶ The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.
-
targetReference¶ The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.
-
group¶ A group of mappings that all have the same source and target system.
-
-
class
cardea.fhir.ConceptMap.ConceptMap_DependsOn(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.
-
property¶ A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somwhere that is labeled to correspond with a code system property.
-
system¶ An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems).
-
code¶ Identity (code or path) or the element/item/ValueSet that the map depends on / refers to.
-
display¶ The display for the code. The display is only provided to help editors when editing the concept map.
-
-
class
cardea.fhir.ConceptMap.ConceptMap_Element(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.
-
code¶ Identity (code or path) or the element/item being mapped.
-
display¶ The display for the code. The display is only provided to help editors when editing the concept map.
-
target¶ A concept from the target value set that this concept maps to.
-
-
class
cardea.fhir.ConceptMap.ConceptMap_Group(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.
-
source¶ An absolute URI that identifies the Code System (if the source is a value set that crosses more than one code system).
-
sourceVersion¶ The specific version of the code system, as determined by the code system authority.
-
target¶ An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems).
-
targetVersion¶ The specific version of the code system, as determined by the code system authority.
-
element¶ Mappings for an individual concept in the source to one or more concepts in the target.
-
unmapped¶ What to do when there is no match in the mappings in the group.
-
-
class
cardea.fhir.ConceptMap.ConceptMap_Target(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.
-
code¶ Identity (code or path) or the element/item that the map refers to.
-
display¶ The display for the code. The display is only provided to help editors when editing the concept map.
-
equivalence¶ The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is ‘wider’ than the source).
-
comment¶ A description of status/issues in mapping that conveys additional information not represented in the structured data.
-
dependsOn¶ A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.
-
product¶ A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.
-
-
class
cardea.fhir.ConceptMap.ConceptMap_Unmapped(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.
-
mode¶ Defines which action to take if there is no match in the group. One of 3 actions is possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).
-
code¶ The fixed code to use when the mode = ‘fixed’ - all unmapped codes are mapped to a single fixed code.
-
display¶ The display for the code. The display is only provided to help editors when editing the concept map.
-
url¶ The canonical URL of the map to use if this map contains no mapping.
-
cardea.fhir.Condition module¶
-
class
cardea.fhir.Condition.Condition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
-
resourceType¶ This is a Condition resource
-
identifier¶ This records identifiers associated with this condition that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
clinicalStatus¶ The clinical status of the condition.
-
verificationStatus¶ The verification status to support the clinical status of the condition.
-
category¶ A category assigned to the condition.
-
severity¶ A subjective assessment of the severity of the condition as evaluated by the clinician.
-
code¶ Identification of the condition, problem or diagnosis.
-
bodySite¶ The anatomical location where this condition manifests itself.
-
subject¶ Indicates the patient or group who the condition record is associated with.
-
context¶ Encounter during which the condition was first asserted.
-
onsetDateTime¶ Estimated or actual date or date-time the condition began, in the opinion of the clinician.
-
onsetAge¶ Estimated or actual date or date-time the condition began, in the opinion of the clinician.
-
onsetPeriod¶ Estimated or actual date or date-time the condition began, in the opinion of the clinician.
-
onsetRange¶ Estimated or actual date or date-time the condition began, in the opinion of the clinician.
-
onsetString¶ Estimated or actual date or date-time the condition began, in the opinion of the clinician.
-
abatementDateTime¶ The date or estimated date that the condition resolved or went into remission. This is called “abatement” because of the many overloaded connotations associated with “remission” or “resolution” - Conditions are never really resolved, but they can abate.
-
abatementAge¶ The date or estimated date that the condition resolved or went into remission. This is called “abatement” because of the many overloaded connotations associated with “remission” or “resolution” - Conditions are never really resolved, but they can abate.
-
abatementBoolean¶ The date or estimated date that the condition resolved or went into remission. This is called “abatement” because of the many overloaded connotations associated with “remission” or “resolution” - Conditions are never really resolved, but they can abate.
-
abatementPeriod¶ The date or estimated date that the condition resolved or went into remission. This is called “abatement” because of the many overloaded connotations associated with “remission” or “resolution” - Conditions are never really resolved, but they can abate.
-
abatementRange¶ The date or estimated date that the condition resolved or went into remission. This is called “abatement” because of the many overloaded connotations associated with “remission” or “resolution” - Conditions are never really resolved, but they can abate.
-
abatementString¶ The date or estimated date that the condition resolved or went into remission. This is called “abatement” because of the many overloaded connotations associated with “remission” or “resolution” - Conditions are never really resolved, but they can abate.
-
assertedDate¶ The date on which the existance of the Condition was first asserted or acknowledged.
-
asserter¶ Individual who is making the condition statement.
-
stage¶ Clinical stage or grade of a condition. May include formal severity assessments.
-
evidence¶ Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed.
-
note¶ Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.
-
-
class
cardea.fhir.Condition.Condition_Evidence(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
-
code¶ A manifestation or symptom that led to the recording of this condition.
-
detail¶ Links to other relevant information, including pathology reports.
-
-
class
cardea.fhir.Condition.Condition_Stage(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
-
summary¶ A simple summary of the stage such as “Stage 3”. The determination of the stage is disease-specific.
-
assessment¶ Reference to a formal record of the evidence on which the staging assessment is based.
-
cardea.fhir.Consent module¶
-
class
cardea.fhir.Consent.Consent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
-
resourceType¶ This is a Consent resource
-
identifier¶ Unique identifier for this copy of the Consent Statement.
-
status¶ Indicates the current state of this consent.
-
category¶ A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
-
patient¶ The patient/healthcare consumer to whom this consent applies.
-
period¶ Relevant time or time-period when this Consent is applicable.
-
dateTime¶ When this Consent was issued / created / indexed.
-
consentingParty¶ Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
-
actor¶ Who or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. ‘admitting officers’).
-
action¶ Actions controlled by this consent.
-
organization¶ The organization that manages the consent, and the framework within which it is executed.
-
sourceAttachment¶ The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
-
sourceIdentifier¶ The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
-
sourceReference¶ The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
-
policy¶ The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
-
policyRule¶ A referece to the specific computable policy.
-
securityLabel¶ A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.
-
purpose¶ The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.
-
dataPeriod¶ Clinical or Operational Relevant period of time that bounds the data controlled by this consent.
-
data¶ The resources controlled by this consent, if specific resources are referenced.
-
except¶ An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
-
-
class
cardea.fhir.Consent.Consent_Actor(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
-
role¶ How the individual is involved in the resources content that is described in the consent.
-
reference¶ The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. ‘admitting officers’).
-
-
class
cardea.fhir.Consent.Consent_Actor1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
-
role¶ How the individual is involved in the resources content that is described in the exception.
-
reference¶ The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. ‘admitting officers’).
-
-
class
cardea.fhir.Consent.Consent_Data(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
-
meaning¶ How the resource reference is interpreted when testing consent restrictions.
-
reference¶ A reference to a specific resource that defines which resources are covered by this consent.
-
-
class
cardea.fhir.Consent.Consent_Data1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
-
meaning¶ How the resource reference is interpreted when testing consent restrictions.
-
reference¶ A reference to a specific resource that defines which resources are covered by this consent.
-
-
class
cardea.fhir.Consent.Consent_Except(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
-
type¶ Action to take - permit or deny - when the exception conditions are met.
-
period¶ The timeframe in this exception is valid.
-
actor¶ Who or what is controlled by this Exception. Use group to identify a set of actors by some property they share (e.g. ‘admitting officers’).
-
action¶ Actions controlled by this Exception.
-
securityLabel¶ A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels.
-
purpose¶ The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception.
-
class¶ The class of information covered by this exception. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.
-
code¶ If this code is found in an instance, then the exception applies.
-
dataPeriod¶ Clinical or Operational Relevant period of time that bounds the data controlled by this exception.
-
data¶ The resources controlled by this exception, if specific resources are referenced.
-
-
class
cardea.fhir.Consent.Consent_Policy(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.
-
uri¶ The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
cardea.fhir.ContactDetail module¶
-
class
cardea.fhir.ContactDetail.ContactDetail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseSpecifies contact information for a person or organization.
-
name¶ The name of an individual to contact.
-
telecom¶ The contact details for the individual (if a name was provided) or the organization.
-
cardea.fhir.ContactPoint module¶
-
class
cardea.fhir.ContactPoint.ContactPoint(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDetails for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
-
system¶ Telecommunications form for contact point - what communications system is required to make use of the contact.
-
value¶ The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
-
use¶ Identifies the purpose for the contact point.
-
rank¶ Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.
-
period¶ Time period when the contact point was/is in use.
-
cardea.fhir.Contract module¶
-
class
cardea.fhir.Contract.Contract(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
resourceType¶ This is a Contract resource
-
identifier¶ Unique identifier for this Contract.
-
status¶ The status of the resource instance.
-
issued¶ When this Contract was issued.
-
applies¶ Relevant time or time-period when this Contract is applicable.
-
subject¶ The target entity impacted by or of interest to parties to the agreement.
-
topic¶ The matter of concern in the context of this agreement.
A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.
-
domain¶ Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.
-
type¶ Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.
-
subType¶ More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.
-
action¶ Action stipulated by this Contract.
-
actionReason¶ Reason for action stipulated by this Contract.
-
decisionType¶ The type of decision made by a grantor with respect to an offer made by a grantee.
-
contentDerivative¶ The minimal content derived from the basal information source at a specific stage in its lifecycle.
-
securityLabel¶ A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.
-
agent¶ An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
-
signer¶ Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.
-
valuedItem¶ Contract Valued Item List.
-
term¶ One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
-
bindingAttachment¶ Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the “source of truth” and which would be the basis for legal action related to enforcement of this Contract.
-
bindingReference¶ Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the “source of truth” and which would be the basis for legal action related to enforcement of this Contract.
-
friendly¶ The “patient friendly language” versionof the Contract in whole or in parts. “Patient friendly language” means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.
-
legal¶ List of Legal expressions or representations of this Contract.
-
rule¶ List of Computable Policy Rule Language Representations of this Contract.
-
-
class
cardea.fhir.Contract.Contract_Agent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
actor¶ Who or what parties are assigned roles in this Contract.
-
role¶ Role type of agent assigned roles in this Contract.
-
-
class
cardea.fhir.Contract.Contract_Agent1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
actor¶ The agent assigned a role in this Contract Provision.
-
role¶ Role played by the agent assigned this role in the execution of this Contract Provision.
-
-
class
cardea.fhir.Contract.Contract_Friendly(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
contentAttachment¶ Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.
-
contentReference¶ Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.
-
-
class
cardea.fhir.Contract.Contract_Legal(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
contentAttachment¶ Contract legal text in human renderable form.
-
contentReference¶ Contract legal text in human renderable form.
-
-
class
cardea.fhir.Contract.Contract_Rule(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
contentAttachment¶ Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).
-
contentReference¶ Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).
-
-
class
cardea.fhir.Contract.Contract_Signer(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
type¶ Role of this Contract signer, e.g. notary, grantee.
-
party¶ Party which is a signator to this Contract.
-
signature¶ Legally binding Contract DSIG signature contents in Base64.
-
-
class
cardea.fhir.Contract.Contract_Term(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
identifier¶ Unique identifier for this particular Contract Provision.
-
issued¶ When this Contract Provision was issued.
-
applies¶ Relevant time or time-period when this Contract Provision is applicable.
-
type¶ Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.
-
subType¶ Subtype of this Contract Provision, e.g. life time maximum payment for a contract term for specific valued item, e.g. disability payment.
-
topic¶ The matter of concern in the context of this provision of the agrement.
-
action¶ Action stipulated by this Contract Provision.
-
actionReason¶ Reason or purpose for the action stipulated by this Contract Provision.
-
securityLabel¶ A set of security labels that define which terms are controlled by this condition.
-
agent¶ An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
-
text¶ Human readable form of this Contract Provision.
-
valuedItem¶ Contract Provision Valued Item List.
-
group¶ Nested group of Contract Provisions.
-
-
class
cardea.fhir.Contract.Contract_ValuedItem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
entityCodeableConcept¶ Specific type of Contract Valued Item that may be priced.
-
entityReference¶ Specific type of Contract Valued Item that may be priced.
-
identifier¶ Identifies a Contract Valued Item instance.
-
effectiveTime¶ Indicates the time during which this Contract ValuedItem information is effective.
-
quantity¶ Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.
-
unitPrice¶ A Contract Valued Item unit valuation measure.
-
factor¶ A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
points¶ An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point.
-
net¶ Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
-
class
cardea.fhir.Contract.Contract_ValuedItem1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
entityCodeableConcept¶ Specific type of Contract Provision Valued Item that may be priced.
-
entityReference¶ Specific type of Contract Provision Valued Item that may be priced.
-
identifier¶ Identifies a Contract Provision Valued Item instance.
-
effectiveTime¶ Indicates the time during which this Contract Term ValuedItem information is effective.
-
quantity¶ Specifies the units by which the Contract Provision Valued Item is measured or counted, and quantifies the countable or measurable Contract Term Valued Item instances.
-
unitPrice¶ A Contract Provision Valued Item unit valuation measure.
-
factor¶ A real number that represents a multiplier used in determining the overall value of the Contract Provision Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
points¶ An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Provision Valued Item delivered. The concept of Points allows for assignment of point values for a Contract ProvisionValued Item, such that a monetary amount can be assigned to each point.
-
net¶ Expresses the product of the Contract Provision Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
cardea.fhir.Contributor module¶
-
class
cardea.fhir.Contributor.Contributor(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
-
type¶ The type of contributor.
-
name¶ The name of the individual or organization responsible for the contribution.
-
contact¶ Contact details to assist a user in finding and communicating with the contributor.
-
cardea.fhir.Count module¶
-
class
cardea.fhir.Count.Count(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
cardea.fhir.Coverage module¶
-
class
cardea.fhir.Coverage.Coverage(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseFinancial instrument which may be used to reimburse or pay for health care products and services.
-
resourceType¶ This is a Coverage resource
-
identifier¶ The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatination of the Coverage.SubscriberID and the Coverage.dependant.
-
status¶ The status of the resource instance.
-
type¶ The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
-
policyHolder¶ The party who ‘owns’ the insurance policy, may be an individual, corporation or the subscriber’s employer.
-
subscriber¶ The party who has signed-up for or ‘owns’ the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.
-
subscriberId¶ The insurer assigned ID for the Subscriber.
-
beneficiary¶ The party who benefits from the insurance coverage., the patient when services are provided.
-
relationship¶ The relationship of beneficiary (patient) to the subscriber.
-
period¶ Time period during which the coverage is in force. A missing start date indicates the start date isn’t known, a missing end date means the coverage is continuing to be in force.
-
payor¶ The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number).
-
grouping¶ A suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan.
-
dependent¶ A unique identifier for a dependent under the coverage.
-
sequence¶ An optional counter for a particular instance of the identified coverage which increments upon each renewal.
-
order¶ The order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care.
-
network¶ The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the ‘in-network’ rate, otherwise ‘out of network’ terms and conditions apply.
-
contract¶ The policy(s) which constitute this insurance coverage.
-
-
class
cardea.fhir.Coverage.Coverage_Grouping(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseFinancial instrument which may be used to reimburse or pay for health care products and services.
-
group¶ Identifies a style or collective of coverage issued by the underwriter, for example may be used to identify an employer group. May also be referred to as a Policy or Group ID.
-
groupDisplay¶ A short description for the group.
-
subGroup¶ Identifies a style or collective of coverage issued by the underwriter, for example may be used to identify a subset of an employer group.
-
subGroupDisplay¶ A short description for the subgroup.
-
plan¶ Identifies a style or collective of coverage issued by the underwriter, for example may be used to identify a collection of benefits provided to employees. May be referred to as a Section or Division ID.
-
planDisplay¶ A short description for the plan.
-
subPlan¶ Identifies a sub-style or sub-collective of coverage issued by the underwriter, for example may be used to identify a subset of a collection of benefits provided to employees.
-
subPlanDisplay¶ A short description for the subplan.
-
class¶ Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage such as a level of deductables or co-payment.
-
classDisplay¶ A short description for the class.
-
subClass¶ Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a subclass of coverage such as a sub-level of deductables or co-payment.
-
subClassDisplay¶ A short description for the subclass.
-
cardea.fhir.DataElement module¶
-
class
cardea.fhir.DataElement.DataElement(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe formal description of a single piece of information that can be gathered and reported.
-
resourceType¶ This is a DataElement resource
-
url¶ An absolute URI that is used to identify this data element when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this data element is (or will be) published. The URL SHOULD include the major version of the data element. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this data element when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the data element when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the data element author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
status¶ The status of this data element. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this data element is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the data element was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the data element changes.
-
publisher¶ The name of the individual or organization that published the data element.
-
name¶ A natural language name identifying the data element. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the data element.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate data element instances.
-
jurisdiction¶ A legal or geographic region in which the data element is intended to be used.
-
copyright¶ A copyright statement relating to the data element and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the data element.
-
stringency¶ Identifies how precise the data element is in its definition.
-
mapping¶ Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.
-
element¶ Defines the structure, type, allowed values and other constraining characteristics of the data element.
-
-
class
cardea.fhir.DataElement.DataElement_Mapping(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe formal description of a single piece of information that can be gathered and reported.
-
identity¶ An internal id that is used to identify this mapping set when specific mappings are made on a per-element basis.
-
uri¶ An absolute URI that identifies the specification that this mapping is expressed to.
-
name¶ A name for the specification that is being mapped to.
-
comment¶ Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.
-
cardea.fhir.DataRequirement module¶
-
class
cardea.fhir.DataRequirement.DataRequirement(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
-
type¶ The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
-
profile¶ The profile of the required data, specified as the uri of the profile definition.
-
mustSupport¶ Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. Note that the value for this element can be a path to allow references to nested elements. In that case, all the elements along the path must be supported.
-
codeFilter¶ Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data.
-
dateFilter¶ Date filters specify additional constraints on the data in terms of the applicable date range for specific elements.
-
-
class
cardea.fhir.DataRequirement.DataRequirement_CodeFilter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
-
path¶ The code-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
-
valueSetString¶ The valueset for the code filter. The valueSet and value elements are exclusive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
-
valueSetReference¶ The valueset for the code filter. The valueSet and value elements are exclusive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
-
valueCode¶ The codes for the code filter. Only one of valueSet, valueCode, valueCoding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes.
-
valueCoding¶ The Codings for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified Codings.
-
valueCodeableConcept¶ The CodeableConcepts for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified CodeableConcepts.
-
-
class
cardea.fhir.DataRequirement.DataRequirement_DateFilter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
-
path¶ The date-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type dateTime, Period, Schedule, or Timing.
-
valueDateTime¶ The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration from now.
-
valuePeriod¶ The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration from now.
-
valueDuration¶ The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration from now.
-
cardea.fhir.DetectedIssue module¶
-
class
cardea.fhir.DetectedIssue.DetectedIssue(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIndicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.
-
resourceType¶ This is a DetectedIssue resource
-
identifier¶ Business identifier associated with the detected issue record.
-
status¶ Indicates the status of the detected issue.
-
category¶ Identifies the general type of issue identified.
-
severity¶ Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
-
patient¶ Indicates the patient whose record the detected issue is associated with.
-
date¶ The date or date-time when the detected issue was initially identified.
Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.
-
implicated¶ Indicates the resource representing the current activity or proposed activity that is potentially problematic.
-
detail¶ A textual explanation of the detected issue.
-
reference¶ The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
-
mitigation¶ Indicates an action that has been taken or is committed to to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.
-
-
class
cardea.fhir.DetectedIssue.DetectedIssue_Mitigation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIndicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.
-
action¶ Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.
-
date¶ Indicates when the mitigating action was documented.
Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.
-
cardea.fhir.Device module¶
-
class
cardea.fhir.Device.Device(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.
-
resourceType¶ This is a Device resource
-
identifier¶ Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
-
udi¶ [Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package.
-
status¶ Status of the Device availability.
-
type¶ Code or identifier to identify a kind of device.
-
lotNumber¶ Lot number assigned by the manufacturer.
-
manufacturer¶ A name of the manufacturer.
-
manufactureDate¶ The date and time when the device was manufactured.
-
expirationDate¶ The date and time beyond which this device is no longer valid or should not be used (if applicable).
-
model¶ The “model” is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.
-
version¶ The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.
-
patient¶ Patient information, If the device is affixed to a person.
-
owner¶ An organization that is responsible for the provision and ongoing maintenance of the device.
-
contact¶ Contact details for an organization or a particular human that is responsible for the device.
-
location¶ The place where the device can be found.
-
url¶ A network address on which the device may be contacted directly.
-
note¶ Descriptive information, usage information or implantation information that is not captured in an existing element.
-
safety¶ Provides additional safety characteristics about a medical device. For example devices containing latex.
-
-
class
cardea.fhir.Device.Device_Udi(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.
-
deviceIdentifier¶ The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.
-
name¶ Name of device as used in labeling or catalog.
-
jurisdiction¶ The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace. with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.
-
carrierHRF¶ The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.
-
carrierAIDC¶ The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - E.g a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded.
-
issuer¶ Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di.
-
entryType¶ A coded entry to indicate how the data was entered.
-
cardea.fhir.DeviceComponent module¶
-
class
cardea.fhir.DeviceComponent.DeviceComponent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe characteristics, operational status and capabilities of a medical-related component of a medical device.
-
resourceType¶ This is a DeviceComponent resource
-
identifier¶ The locally assigned unique identification by the software. For example: handle ID.
-
type¶ The component type as defined in the object-oriented or metric nomenclature partition.
-
lastSystemChange¶ The timestamp for the most recent system change which includes device configuration or setting change.
-
source¶ The link to the source Device that contains administrative device information such as manufacture, serial number, etc.
-
parent¶ The link to the parent resource. For example: Channel is linked to its VMD parent.
-
operationalStatus¶ The current operational status of the device. For example: On, Off, Standby, etc.
-
parameterGroup¶ The parameter group supported by the current device component that is based on some nomenclature, e.g. cardiovascular.
-
measurementPrinciple¶ The physical principle of the measurement. For example: thermal, chemical, acoustical, etc.
-
productionSpecification¶ The production specification such as component revision, serial number, etc.
-
languageCode¶ The language code for the human-readable text string produced by the device. This language code will follow the IETF language tag. Example: en-US.
-
-
class
cardea.fhir.DeviceComponent.DeviceComponent_ProductionSpecification(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe characteristics, operational status and capabilities of a medical-related component of a medical device.
-
specType¶ The specification type, such as, serial number, part number, hardware revision, software revision, etc.
-
componentId¶ The internal component unique identification. This is a provision for manufacture specific standard components using a private OID. 11073-10101 has a partition for private OID semantic that the manufacturer can make use of.
-
productionSpec¶ The printable string defining the component.
-
cardea.fhir.DeviceMetric module¶
-
class
cardea.fhir.DeviceMetric.DeviceMetric(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes a measurement, calculation or setting capability of a medical device.
-
resourceType¶ This is a DeviceMetric resource
-
identifier¶ Describes the unique identification of this metric that has been assigned by the device or gateway software. For example: handle ID. It should be noted that in order to make the identifier unique, the system element of the identifier should be set to the unique identifier of the device.
-
type¶ Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
-
unit¶ Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
-
source¶ Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
-
parent¶ Describes the link to the DeviceComponent that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a DeviceComponent that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location.
-
operationalStatus¶ Indicates current operational state of the device. For example: On, Off, Standby, etc.
-
color¶ Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta.
-
category¶ Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
-
measurementPeriod¶ Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured.
-
calibration¶ Describes the calibrations that have been performed or that are required to be performed.
-
-
class
cardea.fhir.DeviceMetric.DeviceMetric_Calibration(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes a measurement, calculation or setting capability of a medical device.
-
type¶ Describes the type of the calibration method.
-
state¶ Describes the state of the calibration.
-
time¶ Describes the time last calibration has been performed.
-
cardea.fhir.DeviceRequest module¶
-
class
cardea.fhir.DeviceRequest.DeviceRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.
-
resourceType¶ This is a DeviceRequest resource
-
identifier¶ Identifiers assigned to this order by the orderer or by the receiver.
-
definition¶ Protocol or definition followed by this request. For example: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.
-
basedOn¶ Plan/proposal/order fulfilled by this request.
-
priorRequest¶ The request takes the place of the referenced completed or terminated request(s).
-
groupIdentifier¶ Composite request this is part of.
-
status¶ The status of the request.
-
intent¶ Whether the request is a proposal, plan, an original order or a reflex order.
-
priority¶ Indicates how quickly the {{title}} should be addressed with respect to other requests.
-
codeReference¶ The details of the device to be used.
-
codeCodeableConcept¶ The details of the device to be used.
-
subject¶ The patient who will use the device.
-
context¶ An encounter that provides additional context in which this request is made.
-
occurrenceDateTime¶ The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. “Every 8 hours”; “Three times a day”; “1/2 an hour before breakfast for 10 days from 23-Dec 2011:”; “15 Oct 2013, 17 Oct 2013 and 1 Nov 2013”.
-
occurrencePeriod¶ The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. “Every 8 hours”; “Three times a day”; “1/2 an hour before breakfast for 10 days from 23-Dec 2011:”; “15 Oct 2013, 17 Oct 2013 and 1 Nov 2013”.
-
occurrenceTiming¶ The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. “Every 8 hours”; “Three times a day”; “1/2 an hour before breakfast for 10 days from 23-Dec 2011:”; “15 Oct 2013, 17 Oct 2013 and 1 Nov 2013”.
When the request transitioned to being actionable.
-
requester¶ The individual who initiated the request and has responsibility for its activation.
-
performerType¶ Desired type of performer for doing the diagnostic testing.
-
performer¶ The desired perfomer for doing the diagnostic testing.
-
reasonCode¶ Reason or justification for the use of this device.
-
reasonReference¶ Reason or justification for the use of this device.
-
supportingInfo¶ Additional clinical information about the patient that may influence the request fulfilment. For example, this may includes body where on the subject’s the device will be used ( i.e. the target site).
-
note¶ Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.
-
relevantHistory¶ Key events in the history of the request.
-
-
class
cardea.fhir.DeviceRequest.DeviceRequest_Requester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.
-
agent¶ The device, practitioner, etc. who initiated the request.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
cardea.fhir.DeviceUseStatement module¶
-
class
cardea.fhir.DeviceUseStatement.DeviceUseStatement(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a device being used by a patient where the record is the result of a report from the patient or another clinician.
-
resourceType¶ This is a DeviceUseStatement resource
-
identifier¶ An external identifier for this statement such as an IRI.
-
status¶ A code representing the patient or other source’s judgment about the state of the device used that this statement is about. Generally this will be active or completed.
-
subject¶ The patient who used the device.
-
whenUsed¶ The time period over which the device was used.
-
timingTiming¶ How often the device was used.
-
timingPeriod¶ How often the device was used.
-
timingDateTime¶ How often the device was used.
-
recordedOn¶ The time at which the statement was made/recorded.
-
source¶ Who reported the device was being used by the patient.
-
device¶ The details of the device used.
-
indication¶ Reason or justification for the use of the device.
-
bodySite¶ Indicates the site on the subject’s body where the device was used ( i.e. the target site).
-
note¶ Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.
-
cardea.fhir.DiagnosticReport module¶
-
class
cardea.fhir.DiagnosticReport.DiagnosticReport(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.
-
resourceType¶ This is a DiagnosticReport resource
-
identifier¶ Identifiers assigned to this report by the performer or other systems.
-
basedOn¶ Details concerning a test or procedure requested.
-
status¶ The status of the diagnostic report as a whole.
-
category¶ A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.
-
code¶ A code or name that describes this diagnostic report.
-
subject¶ The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.
-
context¶ The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.
-
effectiveDateTime¶ The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
-
effectivePeriod¶ The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
-
issued¶ The date and time that this version of the report was released from the source diagnostic service.
-
performer¶ Indicates who or what participated in producing the report.
-
specimen¶ Details about the specimens on which this diagnostic report is based.
-
result¶ Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. “atomic” results), or they can be grouping observations that include references to other members of the group (e.g. “panels”).
-
imagingStudy¶ One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.
-
image¶ A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
-
conclusion¶ Concise and clinically contextualized impression / summary of the diagnostic report.
-
codedDiagnosis¶ Codes for the conclusion.
-
presentedForm¶ Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.
-
-
class
cardea.fhir.DiagnosticReport.DiagnosticReport_Image(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.
-
comment¶ A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer’s attention to important features.
-
link¶ Reference to the image source.
-
-
class
cardea.fhir.DiagnosticReport.DiagnosticReport_Performer(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.
-
role¶ Describes the type of participation (e.g. a responsible party, author, or verifier).
-
actor¶ The reference to the practitioner or organization involved in producing the report. For example, the diagnostic service that is responsible for issuing the report.
-
cardea.fhir.Distance module¶
-
class
cardea.fhir.Distance.Distance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA length - a value with a unit that is a physical distance.
cardea.fhir.DocumentManifest module¶
-
class
cardea.fhir.DocumentManifest.DocumentManifest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA collection of documents compiled for a purpose together with metadata that applies to the collection.
-
resourceType¶ This is a DocumentManifest resource
-
masterIdentifier¶ A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
-
identifier¶ Other identifiers associated with the document manifest, including version independent identifiers.
-
status¶ The status of this document manifest.
-
type¶ Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.
-
subject¶ Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).
-
created¶ When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).
Identifies who is responsible for creating the manifest, and adding documents to it.
-
recipient¶ A patient, practitioner, or organization for which this set of documents is intended.
-
source¶ Identifies the source system, application, or software that produced the document manifest.
-
description¶ Human-readable description of the source document. This is sometimes known as the “title”.
-
content¶ The list of Documents included in the manifest.
Related identifiers or resources associated with the DocumentManifest.
-
-
class
cardea.fhir.DocumentManifest.DocumentManifest_Content(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA collection of documents compiled for a purpose together with metadata that applies to the collection.
-
pAttachment¶ The list of references to document content, or Attachment that consist of the parts of this document manifest. Usually, these would be document references, but direct references to Media or Attachments are also allowed.
-
pReference¶ The list of references to document content, or Attachment that consist of the parts of this document manifest. Usually, these would be document references, but direct references to Media or Attachments are also allowed.
-
-
class
cardea.fhir.DocumentManifest.DocumentManifest_Related(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA collection of documents compiled for a purpose together with metadata that applies to the collection.
-
identifier¶ Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers.
-
ref¶ Related Resource to this DocumentManifest. For example, Order, ProcedureRequest, Procedure, EligibilityRequest, etc.
-
cardea.fhir.DocumentReference module¶
-
class
cardea.fhir.DocumentReference.DocumentReference(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reference to a document.
-
resourceType¶ This is a DocumentReference resource
-
masterIdentifier¶ Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
-
identifier¶ Other identifiers associated with the document, including version independent identifiers.
-
status¶ The status of this document reference.
-
docStatus¶ The status of the underlying document.
-
type¶ Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
-
class¶ A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
-
subject¶ Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).
-
created¶ When the document was created.
-
indexed¶ When the document reference was created.
Identifies who is responsible for adding the information to the document.
-
authenticator¶ Which person or organization authenticates that this document is valid.
-
custodian¶ Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
-
relatesTo¶ Relationships that this document has with other document references that already exist.
-
description¶ Human-readable description of the source document. This is sometimes known as the “title”.
-
securityLabel¶ A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the “reference” to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
-
content¶ The document and format referenced. There may be multiple content element repetitions, each with a different format.
-
context¶ The clinical context in which the document was prepared.
-
-
class
cardea.fhir.DocumentReference.DocumentReference_Content(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reference to a document.
-
attachment¶ The document or URL of the document along with critical metadata to prove content has integrity.
-
format¶ An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.
-
-
class
cardea.fhir.DocumentReference.DocumentReference_Context(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reference to a document.
-
encounter¶ Describes the clinical encounter or type of care that the document content is associated with.
-
event¶ This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a “History and Physical Report” in which the procedure being documented is necessarily a “History and Physical” act.
-
period¶ The time period over which the service that is described by the document was provided.
-
facilityType¶ The kind of facility where the patient was seen.
-
practiceSetting¶ This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
-
sourcePatientInfo¶ The Patient Information as known when the document was published. May be a reference to a version specific, or contained.
Related identifiers or resources associated with the DocumentReference.
-
-
class
cardea.fhir.DocumentReference.DocumentReference_Related(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reference to a document.
-
identifier¶ Related identifier to this DocumentReference. If both id and ref are present they shall refer to the same thing.
-
ref¶ Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing.
-
-
class
cardea.fhir.DocumentReference.DocumentReference_RelatesTo(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reference to a document.
-
code¶ The type of relationship that this document has with anther document.
-
target¶ The target document of this relationship.
-
cardea.fhir.DomainResource module¶
-
class
cardea.fhir.DomainResource.DomainResource(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA resource that includes narrative, extensions, and contained resources.
-
text¶ A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it “clinically safe” for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
-
contained¶ These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
-
extension¶ May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
modifierExtension¶ May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
-
cardea.fhir.Dosage module¶
-
class
cardea.fhir.Dosage.Dosage(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIndicates how the medication is/was taken or should be taken by the patient.
-
sequence¶ Indicates the order in which the dosage instructions should be applied or interpreted.
-
text¶ Free text dosage instructions e.g. SIG.
-
additionalInstruction¶ Supplemental instruction - e.g. “with meals”.
-
patientInstruction¶ Instructions in terms that are understood by the patient or consumer.
-
timing¶ When medication should be administered.
-
asNeededBoolean¶ Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
-
asNeededCodeableConcept¶ Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
-
site¶ Body site to administer to.
-
route¶ How drug should enter body.
-
method¶ Technique for administering medication.
-
doseRange¶ Amount of medication per dose.
-
doseSimpleQuantity¶ Amount of medication per dose.
-
maxDosePerPeriod¶ Upper limit on medication per unit of time.
-
maxDosePerAdministration¶ Upper limit on medication per administration.
-
maxDosePerLifetime¶ Upper limit on medication per lifetime of the patient.
-
rateRatio¶ Amount of medication per unit of time.
-
rateRange¶ Amount of medication per unit of time.
-
rateSimpleQuantity¶ Amount of medication per unit of time.
-
cardea.fhir.Duration module¶
-
class
cardea.fhir.Duration.Duration(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA length of time.
cardea.fhir.Element module¶
-
class
cardea.fhir.Element.Element(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseBase definition for all elements in a resource.
-
id¶ unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
-
extension¶ May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
cardea.fhir.ElementDefinition module¶
-
class
cardea.fhir.ElementDefinition.ElementDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
path¶ The path identifies the element and is expressed as a “.”-separated list of ancestor elements, beginning with the name of the resource or extension.
-
representation¶ Codes that define how this element is represented in instances, when the deviation varies from the normal case.
-
sliceName¶ The name of this element definition slice, when slicing is working. The name must be a token with no dots or spaces. This is a unique name referring to a specific set of constraints applied to this element, used to provide a name to different slices of the same element.
-
label¶ A single preferred label which is the text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form.
-
code¶ A code that has the same meaning as the element in a particular terminology.
-
slicing¶ Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).
-
short¶ A concise description of what this element means (e.g. for use in autogenerated summaries).
-
definition¶ Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource.
-
comment¶ Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc.
-
requirements¶ This element is for traceability of why the element was created and why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this element.
-
alias¶ Identifies additional names by which this element might also be known.
-
min¶ The minimum number of times this element SHALL appear in the instance.
-
max¶ The maximum number of times this element is permitted to appear in the instance.
-
base¶ Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. This information is provided when the element definition is not the original definition of an element - i.g. either in a constraint on another type, or for elements from a super type in a snap shot.
-
contentReference¶ Identifies the identity of an element defined elsewhere in the profile whose content rules should be applied to the current element.
-
type¶ The data type or resource that the value of this element is permitted to be.
-
defaultValueBoolean¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueInteger¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueDecimal¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueBase64Binary¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueInstant¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueString¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueUri¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueDate¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueDateTime¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueTime¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueCode¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueOid¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueUuid¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueId¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueUnsignedInt¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValuePositiveInt¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueMarkdown¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueElement¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueExtension¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueBackboneElement¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueNarrative¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueAnnotation¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueAttachment¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueIdentifier¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueCodeableConcept¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueCoding¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueQuantity¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueDuration¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueSimpleQuantity¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueDistance¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueCount¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueMoney¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueAge¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueRange¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValuePeriod¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueRatio¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueReference¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueSampledData¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueSignature¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueHumanName¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueAddress¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueContactPoint¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueTiming¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueMeta¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueElementDefinition¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueContactDetail¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueContributor¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueDosage¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueRelatedArtifact¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueUsageContext¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueDataRequirement¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueParameterDefinition¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueTriggerDefinition¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
meaningWhenMissing¶ The Implicit meaning that is to be understood when this element is missing (e.g. ‘when this element is missing, the period is ongoing’.
-
orderMeaning¶ If present, indicates that the order of the repeating element has meaning and describes what that meaning is. If absent, it means that the order of the element has no meaning.
-
fixedBoolean¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedInteger¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedDecimal¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedBase64Binary¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedInstant¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedString¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedUri¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedDate¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedDateTime¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedTime¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedCode¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedOid¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedUuid¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedId¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedUnsignedInt¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedPositiveInt¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedMarkdown¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedElement¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedExtension¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedBackboneElement¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedNarrative¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedAnnotation¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedAttachment¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedIdentifier¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedCodeableConcept¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedCoding¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedQuantity¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedDuration¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedSimpleQuantity¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedDistance¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedCount¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedMoney¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedAge¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedRange¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedPeriod¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedRatio¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedReference¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedSampledData¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedSignature¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedHumanName¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedAddress¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedContactPoint¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedTiming¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedMeta¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedElementDefinition¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedContactDetail¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedContributor¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedDosage¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedRelatedArtifact¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedUsageContext¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedDataRequirement¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedParameterDefinition¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedTriggerDefinition¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
patternBoolean¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternInteger¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternDecimal¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternBase64Binary¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternInstant¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternString¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternUri¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternDate¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternDateTime¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternTime¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternCode¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternOid¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternUuid¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternId¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternUnsignedInt¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternPositiveInt¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternMarkdown¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternElement¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternExtension¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternBackboneElement¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternNarrative¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternAnnotation¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternAttachment¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternIdentifier¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternCodeableConcept¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternCoding¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternQuantity¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternDuration¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternSimpleQuantity¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternDistance¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternCount¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternMoney¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternAge¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternRange¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternPeriod¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternRatio¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternReference¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternSampledData¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternSignature¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternHumanName¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternAddress¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternContactPoint¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternTiming¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternMeta¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternElementDefinition¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternContactDetail¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternContributor¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternDosage¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternRelatedArtifact¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternUsageContext¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternDataRequirement¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternParameterDefinition¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternTriggerDefinition¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
example¶ A sample value for this element demonstrating the type of information that would typically be found in the element.
-
minValueDate¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValueDateTime¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValueInstant¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValueTime¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValueDecimal¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValueInteger¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValuePositiveInt¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValueUnsignedInt¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValueQuantity¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueDate¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueDateTime¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueInstant¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueTime¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueDecimal¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueInteger¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValuePositiveInt¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueUnsignedInt¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueQuantity¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxLength¶ Indicates the maximum length in characters that is permitted to be present in conformant instances and which is expected to be supported by conformant consumers that support the element.
-
condition¶ A reference to an invariant that may make additional statements about the cardinality or value in the instance.
-
constraint¶ Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.
-
mustSupport¶ If true, implementations that produce or consume resources SHALL provide “support” for the element in some meaningful way. If false, the element may be ignored and not supported.
-
isModifier¶ If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.
-
isSummary¶ Whether the element should be included if a client requests a search with the parameter _summary=true.
-
binding¶ Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).
-
mapping¶ Identifies a concept from an external specification that roughly corresponds to this element.
-
-
class
cardea.fhir.ElementDefinition.ElementDefinition_Base(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
path¶ The Path that identifies the base element - this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element - that is, an element definition on a [[[StructureDefinition]]] without a StructureDefinition.base.
-
min¶ Minimum cardinality of the base element identified by the path.
-
max¶ Maximum cardinality of the base element identified by the path.
-
-
class
cardea.fhir.ElementDefinition.ElementDefinition_Binding(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
strength¶ Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.
-
description¶ Describes the intended use of this particular set of codes.
-
valueSetUri¶ Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used. If the binding refers to an explicit value set - the normal case - then use a Reference(ValueSet) preferably containing the canonical URL for the value set. If the reference is to an implicit value set - usually, an IETF RFC that defines a grammar, such as mime types - then use a uri.
-
valueSetReference¶ Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used. If the binding refers to an explicit value set - the normal case - then use a Reference(ValueSet) preferably containing the canonical URL for the value set. If the reference is to an implicit value set - usually, an IETF RFC that defines a grammar, such as mime types - then use a uri.
-
-
class
cardea.fhir.ElementDefinition.ElementDefinition_Constraint(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
key¶ Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.
-
requirements¶ Description of why this constraint is necessary or appropriate.
-
severity¶ Identifies the impact constraint violation has on the conformance of the instance.
-
human¶ Text that can be used to describe the constraint in messages identifying that the constraint has been violated.
-
expression¶ A [FHIRPath](http://hl7.org/fluentpath) expression of constraint that can be executed to see if this constraint is met.
-
xpath¶ An XPath expression of constraint that can be executed to see if this constraint is met.
-
source¶ A reference to the original source of the constraint, for traceability purposes.
-
-
class
cardea.fhir.ElementDefinition.ElementDefinition_Discriminator(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
type¶ How the element value is interpreted when discrimination is evaluated.
-
path¶ A FHIRPath expression, using a restricted subset of FHIRPath, that is used to identify the element on which discrimination is based.
-
-
class
cardea.fhir.ElementDefinition.ElementDefinition_Example(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
label¶ Describes the purpose of this example amoung the set of examples.
-
valueBoolean¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueInteger¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueDecimal¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueBase64Binary¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueInstant¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueString¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueUri¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueDate¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueDateTime¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueTime¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueCode¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueOid¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueUuid¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueId¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueUnsignedInt¶ The actual value for the element, which must be one of the types allowed for this element.
-
valuePositiveInt¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueMarkdown¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueElement¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueExtension¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueBackboneElement¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueNarrative¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueAnnotation¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueAttachment¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueIdentifier¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueCodeableConcept¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueCoding¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueQuantity¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueDuration¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueSimpleQuantity¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueDistance¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueCount¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueMoney¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueAge¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueRange¶ The actual value for the element, which must be one of the types allowed for this element.
-
valuePeriod¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueRatio¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueReference¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueSampledData¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueSignature¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueHumanName¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueAddress¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueContactPoint¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueTiming¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueMeta¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueElementDefinition¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueContactDetail¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueContributor¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueDosage¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueRelatedArtifact¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueUsageContext¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueDataRequirement¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueParameterDefinition¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueTriggerDefinition¶ The actual value for the element, which must be one of the types allowed for this element.
-
-
class
cardea.fhir.ElementDefinition.ElementDefinition_Mapping(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
identity¶ An internal reference to the definition of a mapping.
-
language¶ Identifies the computable language in which mapping.map is expressed.
-
map¶ Expresses what part of the target specification corresponds to this element.
-
comment¶ Comments that provide information about the mapping or its use.
-
-
class
cardea.fhir.ElementDefinition.ElementDefinition_Slicing(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
discriminator¶ Designates which child elements are used to discriminate between the slices when processing an instance. If one or more discriminators are provided, the value of the child elements in the instance data SHALL completely distinguish which slice the element in the resource matches based on the allowed values for those elements in each of the slices.
-
description¶ A human-readable text description of how the slicing works. If there is no discriminator, this is required to be present to provide whatever information is possible about how the slices can be differentiated.
-
ordered¶ If the matching elements have to occur in the same order as defined in the profile.
-
rules¶ Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.
-
-
class
cardea.fhir.ElementDefinition.ElementDefinition_Type(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
code¶ URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. “string” is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.
-
profile¶ Identifies a profile structure or implementation Guide that SHALL hold for the datatype this element refers to. Can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide.
-
targetProfile¶ Identifies a profile structure or implementation Guide that SHALL hold for the target of the reference this element refers to. Can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide.
-
aggregation¶ If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.
-
versioning¶ Whether this reference needs to be version specific or version independent, or whether either can be used.
-
cardea.fhir.EligibilityRequest module¶
-
class
cardea.fhir.EligibilityRequest.EligibilityRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe EligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an EligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.
-
resourceType¶ This is a EligibilityRequest resource
-
identifier¶ The Response business identifier.
-
status¶ The status of the resource instance.
-
priority¶ Immediate (STAT), best effort (NORMAL), deferred (DEFER).
-
patient¶ Patient Resource.
-
servicedDate¶ The date or dates when the enclosed suite of services were performed or completed.
-
servicedPeriod¶ The date or dates when the enclosed suite of services were performed or completed.
-
created¶ The date when this resource was created.
-
enterer¶ Person who created the invoice/claim/pre-determination or pre-authorization.
-
provider¶ The practitioner who is responsible for the services rendered to the patient.
-
organization¶ The organization which is responsible for the services rendered to the patient.
-
insurer¶ The Insurer who is target of the request.
-
facility¶ Facility where the services were provided.
-
coverage¶ Financial instrument by which payment information for health care.
-
businessArrangement¶ The contract number of a business agreement which describes the terms and conditions.
-
benefitCategory¶ Dental, Vision, Medical, Pharmacy, Rehab etc.
-
benefitSubCategory¶ Dental: basic, major, ortho; Vision exam, glasses, contacts; etc.
-
cardea.fhir.EligibilityResponse module¶
-
class
cardea.fhir.EligibilityResponse.EligibilityResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides eligibility and plan details from the processing of an Eligibility resource.
-
resourceType¶ This is a EligibilityResponse resource
-
identifier¶ The Response business identifier.
-
status¶ The status of the resource instance.
-
created¶ The date when the enclosed suite of services were performed or completed.
-
requestProvider¶ The practitioner who is responsible for the services rendered to the patient.
-
requestOrganization¶ The organization which is responsible for the services rendered to the patient.
-
request¶ Original request resource reference.
-
outcome¶ Transaction status: error, complete.
-
disposition¶ A description of the status of the adjudication.
-
insurer¶ The Insurer who produced this adjudicated response.
-
inforce¶ Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.
-
insurance¶ The insurer may provide both the details for the requested coverage as well as details for additional coverages known to the insurer.
-
form¶ The form to be used for printing the content.
-
error¶ Mutually exclusive with Services Provided (Item).
-
-
class
cardea.fhir.EligibilityResponse.EligibilityResponse_BenefitBalance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides eligibility and plan details from the processing of an Eligibility resource.
-
category¶ Dental, Vision, Medical, Pharmacy, Rehab etc.
-
subCategory¶ Dental: basic, major, ortho; Vision exam, glasses, contacts; etc.
-
excluded¶ True if the indicated class of service is excluded from the plan, missing or False indicated the service is included in the coverage.
-
name¶ A short name or tag for the benefit, for example MED01, or DENT2.
-
description¶ A richer description of the benefit, for example ‘DENT2 covers 100% of basic, 50% of major but exclused Ortho, Implants and Costmetic services’.
-
network¶ Network designation.
-
unit¶ Unit designation: individual or family.
-
term¶ The term or period of the values such as ‘maximum lifetime benefit’ or ‘maximum annual vistis’.
-
financial¶ Benefits Used to date.
-
-
class
cardea.fhir.EligibilityResponse.EligibilityResponse_Error(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides eligibility and plan details from the processing of an Eligibility resource.
-
code¶ An error code,from a specified code system, which details why the eligibility check could not be performed.
-
-
class
cardea.fhir.EligibilityResponse.EligibilityResponse_Financial(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides eligibility and plan details from the processing of an Eligibility resource.
-
type¶ Deductable, visits, benefit amount.
-
allowedUnsignedInt¶ Benefits allowed.
-
allowedString¶ Benefits allowed.
-
allowedMoney¶ Benefits allowed.
-
usedUnsignedInt¶ Benefits used.
-
usedMoney¶ Benefits used.
-
-
class
cardea.fhir.EligibilityResponse.EligibilityResponse_Insurance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides eligibility and plan details from the processing of an Eligibility resource.
-
coverage¶ A suite of updated or additional Coverages from the Insurer.
-
contract¶ The contract resource which may provide more detailed information.
-
benefitBalance¶ Benefits and optionally current balances by Category.
-
cardea.fhir.Encounter module¶
-
class
cardea.fhir.Encounter.Encounter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
-
resourceType¶ This is a Encounter resource
-
identifier¶ Identifier(s) by which this encounter is known.
-
status¶ planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
-
statusHistory¶ The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
-
class¶ inpatient | outpatient | ambulatory | emergency +.
-
classHistory¶ The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transisions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kindof discharge from emergency to inpatient.
-
type¶ Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
-
priority¶ Indicates the urgency of the encounter.
-
subject¶ The patient ro group present at the encounter.
-
episodeOfCare¶ Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
-
incomingReferral¶ The referral request this encounter satisfies (incoming referral).
-
participant¶ The list of people responsible for providing the service.
-
appointment¶ The appointment that scheduled this encounter.
-
period¶ The start and end time of the encounter.
-
length¶ Quantity of time the encounter lasted. This excludes the time during leaves of absence.
-
reason¶ Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
-
diagnosis¶ The list of diagnosis relevant to this encounter.
-
account¶ The set of accounts that may be used for billing for this Encounter.
-
hospitalization¶ Details about the admission to a healthcare service.
-
location¶ List of locations where the patient has been during this encounter.
-
serviceProvider¶ An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location’s Organization.
-
partOf¶ Another Encounter of which this encounter is a part of (administratively or in time).
-
-
class
cardea.fhir.Encounter.Encounter_ClassHistory(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
-
class¶ inpatient | outpatient | ambulatory | emergency +.
-
period¶ The time that the episode was in the specified class.
-
-
class
cardea.fhir.Encounter.Encounter_Diagnosis(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
-
condition¶ Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
-
role¶ Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).
-
rank¶ Ranking of the diagnosis (for each role type).
-
-
class
cardea.fhir.Encounter.Encounter_Hospitalization(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
-
preAdmissionIdentifier¶ Pre-admission identifier.
-
origin¶ The location from which the patient came before admission.
-
admitSource¶ From where patient was admitted (physician referral, transfer).
-
reAdmission¶ Whether this hospitalization is a readmission and why if known.
-
dietPreference¶ Diet preferences reported by the patient.
-
specialCourtesy¶ Special courtesies (VIP, board member).
-
specialArrangement¶ Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.
-
destination¶ Location to which the patient is discharged.
-
dischargeDisposition¶ Category or kind of location after discharge.
-
-
class
cardea.fhir.Encounter.Encounter_Location(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
-
location¶ The location where the encounter takes place.
-
status¶ The status of the participants’ presence at the specified location during the period specified. If the participant is is no longer at the location, then the period will have an end date/time.
-
period¶ Time period during which the patient was present at the location.
-
-
class
cardea.fhir.Encounter.Encounter_Participant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
-
type¶ Role of participant in encounter.
-
period¶ The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter’s period.
-
individual¶ Persons involved in the encounter other than the patient.
-
-
class
cardea.fhir.Encounter.Encounter_StatusHistory(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
-
status¶ planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
-
period¶ The time that the episode was in the specified status.
-
cardea.fhir.Endpoint module¶
-
class
cardea.fhir.Endpoint.Endpoint(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.
-
resourceType¶ This is a Endpoint resource
-
identifier¶ Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
-
status¶ active | suspended | error | off | test.
-
connectionType¶ A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
-
name¶ A friendly name that this endpoint can be referred to with.
-
managingOrganization¶ The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).
-
contact¶ Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
-
period¶ The interval during which the endpoint is expected to be operational.
-
payloadType¶ The payload type describes the acceptable content that can be communicated on the endpoint.
-
payloadMimeType¶ The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
-
address¶ The uri that describes the actual end-point to connect to.
-
header¶ Additional headers / information to send as part of the notification.
-
cardea.fhir.EnrollmentRequest module¶
-
class
cardea.fhir.EnrollmentRequest.EnrollmentRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the insurance enrollment details to the insurer regarding a specified coverage.
-
resourceType¶ This is a EnrollmentRequest resource
-
identifier¶ The Response business identifier.
-
status¶ The status of the resource instance.
-
created¶ The date when this resource was created.
-
insurer¶ The Insurer who is target of the request.
-
provider¶ The practitioner who is responsible for the services rendered to the patient.
-
organization¶ The organization which is responsible for the services rendered to the patient.
-
subject¶ Patient Resource.
-
coverage¶ Reference to the program or plan identification, underwriter or payor.
-
cardea.fhir.EnrollmentResponse module¶
-
class
cardea.fhir.EnrollmentResponse.EnrollmentResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides enrollment and plan details from the processing of an Enrollment resource.
-
resourceType¶ This is a EnrollmentResponse resource
-
identifier¶ The Response business identifier.
-
status¶ The status of the resource instance.
-
request¶ Original request resource reference.
-
outcome¶ Processing status: error, complete.
-
disposition¶ A description of the status of the adjudication.
-
created¶ The date when the enclosed suite of services were performed or completed.
-
organization¶ The Insurer who produced this adjudicated response.
-
requestProvider¶ The practitioner who is responsible for the services rendered to the patient.
-
requestOrganization¶ The organization which is responsible for the services rendered to the patient.
-
cardea.fhir.EpisodeOfCare module¶
-
class
cardea.fhir.EpisodeOfCare.EpisodeOfCare(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
-
resourceType¶ This is a EpisodeOfCare resource
-
identifier¶ The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.
-
status¶ planned | waitlist | active | onhold | finished | cancelled.
-
statusHistory¶ The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).
-
type¶ A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.
-
diagnosis¶ The list of diagnosis relevant to this episode of care.
-
patient¶ The patient who is the focus of this episode of care.
-
managingOrganization¶ The organization that has assumed the specific responsibilities for the specified duration.
-
period¶ The interval during which the managing organization assumes the defined responsibility.
-
referralRequest¶ Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.
-
careManager¶ The practitioner that is the care manager/care co-ordinator for this patient.
-
team¶ The list of practitioners that may be facilitating this episode of care for specific purposes.
-
account¶ The set of accounts that may be used for billing for this EpisodeOfCare.
-
-
class
cardea.fhir.EpisodeOfCare.EpisodeOfCare_Diagnosis(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
-
condition¶ A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.
-
role¶ Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …).
-
rank¶ Ranking of the diagnosis (for each role type).
-
-
class
cardea.fhir.EpisodeOfCare.EpisodeOfCare_StatusHistory(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
-
status¶ planned | waitlist | active | onhold | finished | cancelled.
-
period¶ The period during this EpisodeOfCare that the specific status applied.
-
cardea.fhir.ExpansionProfile module¶
-
class
cardea.fhir.ExpansionProfile.ExpansionProfile(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
resourceType¶ This is a ExpansionProfile resource
-
url¶ An absolute URI that is used to identify this expansion profile when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this expansion profile is (or will be) published. The URL SHOULD include the major version of the expansion profile. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this expansion profile when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the expansion profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the expansion profile author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the expansion profile. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
status¶ The status of this expansion profile. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this expansion profile is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the expansion profile was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the expansion profile changes.
-
publisher¶ The name of the individual or organization that published the expansion profile.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the expansion profile from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate expansion profile instances.
-
jurisdiction¶ A legal or geographic region in which the expansion profile is intended to be used.
-
fixedVersion¶ Fix use of a particular code system to a particular version.
-
excludedSystem¶ Code system, or a particular version of a code system to be excluded from value set expansions.
-
includeDesignations¶ Controls whether concept designations are to be included or excluded in value set expansions.
-
designation¶ A set of criteria that provide the constraints imposed on the value set expansion by including or excluding designations.
-
includeDefinition¶ Controls whether the value set definition is included or excluded in value set expansions.
-
activeOnly¶ Controls whether inactive concepts are included or excluded in value set expansions.
-
excludeNested¶ Controls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains).
-
excludeNotForUI¶ Controls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.
-
excludePostCoordinated¶ Controls whether or not the value set expansion includes post coordinated codes.
-
displayLanguage¶ Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.
-
limitedExpansion¶ If the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete, using the extension [http://hl7.org/fhir/StructureDefinition/valueset-toocostly](extension-valueset-toocostly.html).
-
-
class
cardea.fhir.ExpansionProfile.ExpansionProfile_Designation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
include¶ Designations to be included.
-
exclude¶ Designations to be excluded.
-
-
class
cardea.fhir.ExpansionProfile.ExpansionProfile_Designation1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
language¶ The language this designation is defined for.
-
use¶ Which kinds of designation to include in the expansion.
-
-
class
cardea.fhir.ExpansionProfile.ExpansionProfile_Designation2(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
language¶ The language this designation is defined for.
-
use¶ Which kinds of designation to exclude from the expansion.
-
-
class
cardea.fhir.ExpansionProfile.ExpansionProfile_Exclude(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
designation¶ A data group for each designation to be excluded.
-
-
class
cardea.fhir.ExpansionProfile.ExpansionProfile_ExcludedSystem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
system¶ An absolute URI which is the code system to be excluded.
-
version¶ The version of the code system from which codes in the expansion should be excluded.
-
-
class
cardea.fhir.ExpansionProfile.ExpansionProfile_FixedVersion(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
system¶ The specific system for which to fix the version.
-
version¶ The version of the code system from which codes in the expansion should be included.
-
mode¶ How to manage the intersection between a fixed version in a value set, and this fixed version of the system in the expansion profile.
-
-
class
cardea.fhir.ExpansionProfile.ExpansionProfile_Include(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
designation¶ A data group for each designation to be included.
-
cardea.fhir.ExplanationOfBenefit module¶
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
resourceType¶ This is a ExplanationOfBenefit resource
-
identifier¶ The EOB Business Identifier.
-
status¶ The status of the resource instance.
-
type¶ The category of claim, eg, oral, pharmacy, vision, insitutional, professional.
-
subType¶ A finer grained suite of claim subtype codes which may convey Inpatient vs Outpatient and/or a specialty service. In the US the BillType.
-
patient¶ Patient Resource.
-
billablePeriod¶ The billable period for which charges are being submitted.
-
created¶ The date when the EOB was created.
-
enterer¶ The person who created the explanation of benefit.
-
insurer¶ The insurer which is responsible for the explanation of benefit.
-
provider¶ The provider which is responsible for the claim.
-
organization¶ The provider which is responsible for the claim.
-
referral¶ The referral resource which lists the date, practitioner, reason and other supporting information.
-
facility¶ Facility where the services were provided.
-
claim¶ The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number.
-
claimResponse¶ The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number.
-
outcome¶ Processing outcome errror, partial or complete processing.
-
disposition¶ A description of the status of the adjudication.
Other claims which are related to this claim such as prior claim versions or for related services.
-
prescription¶ Prescription to support the dispensing of Pharmacy or Vision products.
-
originalPrescription¶ Original prescription which has been superceded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new precription for an alternate medication which has the same theraputic intent. The prescription from the pharmacy becomes the ‘prescription’ and that from the physician becomes the ‘original prescription’.
-
payee¶ The party to be reimbursed for the services.
-
information¶ Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are mutiple jurisdiction specific valuesets which are required.
-
careTeam¶ The members of the team who provided the overall service as well as their role and whether responsible and qualifications.
-
diagnosis¶ Ordered list of patient diagnosis for which care is sought.
-
procedure¶ Ordered list of patient procedures performed to support the adjudication.
-
precedence¶ Precedence (primary, secondary, etc.).
-
insurance¶ Financial instrument by which payment information for health care.
-
accident¶ An accident which resulted in the need for healthcare services.
-
employmentImpacted¶ The start and optional end dates of when the patient was precluded from working due to the treatable condition(s).
-
hospitalization¶ The start and optional end dates of when the patient was confined to a treatment center.
-
item¶ First tier of goods and services.
-
addItem¶ The first tier service adjudications for payor added services.
-
totalCost¶ The total cost of the services reported.
-
unallocDeductable¶ The amount of deductable applied which was not allocated to any particular service line.
-
totalBenefit¶ Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductable).
-
payment¶ Payment details for the claim if the claim has been paid.
-
form¶ The form to be used for printing the content.
-
processNote¶ Note text.
-
benefitBalance¶ Balance by Benefit Category.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_Accident(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
date¶ Date of an accident which these services are addressing.
-
type¶ Type of accident: work, auto, etc.
-
locationAddress¶ Where the accident occurred.
-
locationReference¶ Where the accident occurred.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_AddItem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequenceLinkId¶ List of input service items which this service line is intended to replace.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. ‘glasses’ or ‘compound’.
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
fee¶ The fee charged for the professional service or product.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
detail¶ The second tier service adjudications for payor added services.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_Adjudication(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
category¶ Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.
-
reason¶ Adjudication reason such as limit reached.
-
amount¶ Monitory amount associated with the code.
-
value¶ A non-monetary value for example a percentage. Mutually exclusive to the amount element above.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_BenefitBalance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
category¶ Dental, Vision, Medical, Pharmacy, Rehab etc.
-
subCategory¶ Dental: basic, major, ortho; Vision exam, glasses, contacts; etc.
-
excluded¶ True if the indicated class of service is excluded from the plan, missing or False indicated the service is included in the coverage.
-
name¶ A short name or tag for the benefit, for example MED01, or DENT2.
-
description¶ A richer description of the benefit, for example ‘DENT2 covers 100% of basic, 50% of major but exclused Ortho, Implants and Costmetic services’.
-
network¶ Network designation.
-
unit¶ Unit designation: individual or family.
-
term¶ The term or period of the values such as ‘maximum lifetime benefit’ or ‘maximum annual vistis’.
-
financial¶ Benefits Used to date.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_CareTeam(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequence¶ Sequence of careteam which serves to order and provide a link.
-
provider¶ The members of the team who provided the overall service.
-
responsible¶ The practitioner who is billing and responsible for the claimed services rendered to the patient.
-
role¶ The lead, assisting or supervising practitioner and their discipline if a multidisiplinary team.
-
qualification¶ The qualification which is applicable for this service.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_Detail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequence¶ A service line number.
-
type¶ The type of product or service.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. ‘glasses’ or ‘compound’.
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
programCode¶ For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.
-
quantity¶ The number of repetitions of a service or product.
-
unitPrice¶ If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.
-
factor¶ A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
net¶ The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
udi¶ List of Unique Device Identifiers associated with this line item.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
subDetail¶ Third tier of goods and services.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_Detail1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI).
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
fee¶ The fee charged for the professional service or product.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_Diagnosis(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequence¶ Sequence of diagnosis which serves to provide a link.
-
diagnosisCodeableConcept¶ The diagnosis.
-
diagnosisReference¶ The diagnosis.
-
type¶ The type of the Diagnosis, for example: admitting, primary, secondary, discharge.
-
packageCode¶ The package billing code, for example DRG, based on the assigned grouping code system.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_Financial(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
type¶ Deductable, visits, benefit amount.
-
allowedUnsignedInt¶ Benefits allowed.
-
allowedString¶ Benefits allowed.
-
allowedMoney¶ Benefits allowed.
-
usedUnsignedInt¶ Benefits used.
-
usedMoney¶ Benefits used.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_Information(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequence¶ Sequence of the information element which serves to provide a link.
-
category¶ The general class of the information supplied: information; exception; accident, employment; onset, etc.
-
code¶ System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought which may influence the adjudication.
-
timingDate¶ The date when or period to which this information refers.
-
timingPeriod¶ The date when or period to which this information refers.
-
valueString¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
valueQuantity¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
valueAttachment¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
valueReference¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
reason¶ For example, provides the reason for: the additional stay, or missing tooth or any other situation where a reason code is required in addition to the content.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_Insurance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
coverage¶ Reference to the program or plan identification, underwriter or payor.
-
preAuthRef¶ A list of references from the Insurer to which these services pertain.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_Item(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequence¶ A service line number.
-
careTeamLinkId¶ Careteam applicable for this service or product line.
-
diagnosisLinkId¶ Diagnosis applicable for this service or product line.
-
procedureLinkId¶ Procedures applicable for this service or product line.
-
informationLinkId¶ Exceptions, special conditions and supporting information pplicable for this service or product line.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. ‘glasses’ or ‘compound’.
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
programCode¶ For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.
-
servicedDate¶ The date or dates when the enclosed suite of services were performed or completed.
-
servicedPeriod¶ The date or dates when the enclosed suite of services were performed or completed.
-
locationCodeableConcept¶ Where the service was provided.
-
locationAddress¶ Where the service was provided.
-
locationReference¶ Where the service was provided.
-
quantity¶ The number of repetitions of a service or product.
-
unitPrice¶ If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.
-
factor¶ A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
net¶ The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
udi¶ List of Unique Device Identifiers associated with this line item.
-
bodySite¶ Physical service site on the patient (limb, tooth, etc).
-
subSite¶ A region or surface of the site, eg. limb region or tooth surface(s).
-
encounter¶ A billed item may include goods or services provided in multiple encounters.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
detail¶ Second tier of goods and services.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_Payee(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
type¶ Type of Party to be reimbursed: Subscriber, provider, other.
-
resourceType¶ organization | patient | practitioner | relatedperson.
-
party¶ Party to be reimbursed: Subscriber, provider, other.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_Payment(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
type¶ Whether this represents partial or complete payment of the claim.
-
adjustment¶ Adjustment to the payment of this transaction which is not related to adjudication of this transaction.
-
adjustmentReason¶ Reason for the payment adjustment.
-
date¶ Estimated payment date.
-
amount¶ Payable less any payment adjustment.
-
identifier¶ Payment identifer.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_Procedure(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequence¶ Sequence of procedures which serves to order and provide a link.
-
date¶ Date and optionally time the procedure was performed .
-
procedureCodeableConcept¶ The procedure code.
-
procedureReference¶ The procedure code.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_ProcessNote(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
number¶ An integer associated with each note which may be referred to from each service line item.
-
type¶ The note purpose: Print/Display.
-
text¶ The note text.
-
language¶ The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. “en” for English, or “en-US” for American English versus “en-EN” for England English.
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_Related(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
claim¶ Other claims which are related to this claim such as prior claim versions or for related services.
-
relationship¶ For example prior or umbrella.
-
reference¶ An alternate organizational reference to the case or file to which this particular claim pertains - eg Property/Casualy insurer claim # or Workers Compensation case # .
-
-
class
cardea.fhir.ExplanationOfBenefit.ExplanationOfBenefit_SubDetail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequence¶ A service line number.
-
type¶ The type of product or service.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI).
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
programCode¶ For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.
-
quantity¶ The number of repetitions of a service or product.
-
unitPrice¶ The fee for an addittional service or product or charge.
-
factor¶ A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
net¶ The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
udi¶ List of Unique Device Identifiers associated with this line item.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
cardea.fhir.Extension module¶
-
class
cardea.fhir.Extension.Extension(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseOptional Extension Element - found in all resources.
-
url¶ Source of the definition for the extension code - a logical name or a URL.
-
valueBoolean¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueInteger¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueDecimal¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueBase64Binary¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueInstant¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueString¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueUri¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueDate¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueDateTime¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueTime¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueCode¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueOid¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueUuid¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueId¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueUnsignedInt¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valuePositiveInt¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueMarkdown¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueElement¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueExtension¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueBackboneElement¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueNarrative¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueAnnotation¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueAttachment¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueIdentifier¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueCodeableConcept¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueCoding¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueQuantity¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueDuration¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueSimpleQuantity¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueDistance¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueCount¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueMoney¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueAge¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueRange¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valuePeriod¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueRatio¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueReference¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueSampledData¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueSignature¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueHumanName¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueAddress¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueContactPoint¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueTiming¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueMeta¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueElementDefinition¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueContactDetail¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueContributor¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueDosage¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueRelatedArtifact¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueUsageContext¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueDataRequirement¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueParameterDefinition¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueTriggerDefinition¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
cardea.fhir.FamilyMemberHistory module¶
-
class
cardea.fhir.FamilyMemberHistory.FamilyMemberHistory(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseSignificant health events and conditions for a person related to the patient relevant in the context of care for the patient.
-
resourceType¶ This is a FamilyMemberHistory resource
-
identifier¶ This records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
definition¶ A protocol or questionnaire that was adhered to in whole or in part by this event.
-
status¶ A code specifying the status of the record of the family history of a specific family member.
-
notDone¶ If true, indicates the taking of an individual family member’s history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.
-
notDoneReason¶ Describes why the family member’s history is absent.
-
patient¶ The person who this history concerns.
-
date¶ The date (and possibly time) when the family member history was taken.
-
name¶ This will either be a name or a description; e.g. “Aunt Susan”, “my cousin with the red hair”.
-
relationship¶ The type of relationship this person has to the patient (father, mother, brother etc.).
-
gender¶ Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
-
bornPeriod¶ The actual or approximate date of birth of the relative.
-
bornDate¶ The actual or approximate date of birth of the relative.
-
bornString¶ The actual or approximate date of birth of the relative.
-
ageAge¶ The age of the relative at the time the family member history is recorded.
-
ageRange¶ The age of the relative at the time the family member history is recorded.
-
ageString¶ The age of the relative at the time the family member history is recorded.
-
estimatedAge¶ If true, indicates that the age value specified is an estimated value.
-
deceasedBoolean¶ Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
-
deceasedAge¶ Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
-
deceasedRange¶ Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
-
deceasedDate¶ Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
-
deceasedString¶ Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
-
reasonCode¶ Describes why the family member history occurred in coded or textual form.
-
reasonReference¶ Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
-
note¶ This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.
-
condition¶ The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.
-
-
class
cardea.fhir.FamilyMemberHistory.FamilyMemberHistory_Condition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseSignificant health events and conditions for a person related to the patient relevant in the context of care for the patient.
-
code¶ The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like ‘cancer’ depending on how much is known about the condition and the capabilities of the creating system.
-
outcome¶ Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.
-
onsetAge¶ Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
-
onsetRange¶ Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
-
onsetPeriod¶ Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
-
onsetString¶ Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
-
note¶ An area where general notes can be placed about this specific condition.
-
cardea.fhir.Flag module¶
-
class
cardea.fhir.Flag.Flag(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseProspective warnings of potential issues when providing care to the patient.
-
resourceType¶ This is a Flag resource
-
identifier¶ Identifier assigned to the flag for external use (outside the FHIR environment).
-
status¶ Supports basic workflow.
-
category¶ Allows an flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.
-
code¶ The coded value or textual component of the flag to display to the user.
-
subject¶ The patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with.
-
period¶ The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.
-
encounter¶ This alert is only relevant during the encounter.
The person, organization or device that created the flag.
-
cardea.fhir.Goal module¶
-
class
cardea.fhir.Goal.Goal(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
-
resourceType¶ This is a Goal resource
-
identifier¶ This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
status¶ Indicates whether the goal has been reached and is still considered relevant.
-
category¶ Indicates a category the goal falls within.
-
priority¶ Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
-
description¶ Human-readable and/or coded description of a specific desired objective of care, such as “control blood pressure” or “negotiate an obstacle course” or “dance with child at wedding”.
-
subject¶ Identifies the patient, group or organization for whom the goal is being established.
-
startDate¶ The date or event after which the goal should begin being pursued.
-
startCodeableConcept¶ The date or event after which the goal should begin being pursued.
-
target¶ Indicates what should be done by when.
-
statusDate¶ Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
-
statusReason¶ Captures the reason for the current status.
-
expressedBy¶ Indicates whose goal this is - patient goal, practitioner goal, etc.
-
addresses¶ The identified conditions and other health record elements that are intended to be addressed by the goal.
-
note¶ Any comments related to the goal.
-
outcomeCode¶ Identifies the change (or lack of change) at the point when the status of the goal is assessed.
-
outcomeReference¶ Details of what’s changed (or not changed).
-
-
class
cardea.fhir.Goal.Goal_Target(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
-
measure¶ The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
-
detailQuantity¶ The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
-
detailRange¶ The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
-
detailCodeableConcept¶ The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
-
dueDate¶ Indicates either the date or the duration after start by which the goal should be met.
-
dueDuration¶ Indicates either the date or the duration after start by which the goal should be met.
-
cardea.fhir.GraphDefinition module¶
-
class
cardea.fhir.GraphDefinition.GraphDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.
-
resourceType¶ This is a GraphDefinition resource
-
url¶ An absolute URI that is used to identify this graph definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this graph definition is (or will be) published. The URL SHOULD include the major version of the graph definition. For more information see [Technical and Business Versions](resource.html#versions).
-
version¶ The identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
status¶ The status of this graph definition. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the graph definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the graph definition changes.
-
publisher¶ The name of the individual or organization that published the graph definition.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the graph definition from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate graph definition instances.
-
jurisdiction¶ A legal or geographic region in which the graph definition is intended to be used.
-
purpose¶ Explaination of why this graph definition is needed and why it has been designed as it has.
-
start¶ The type of FHIR resource at which instances of this graph start.
-
profile¶ The profile that describes the use of the base resource.
-
link¶ Links this graph makes rules about.
-
-
class
cardea.fhir.GraphDefinition.GraphDefinition_Compartment(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.
-
code¶ Identifies the compartment.
-
rule¶ identical | matching | different | no-rule | custom.
-
expression¶ Custom rule, as a FHIRPath expression.
-
description¶ Documentation for FHIRPath expression.
-
-
class
cardea.fhir.GraphDefinition.GraphDefinition_Link(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.
-
path¶ Path in the resource that contains the link.
-
sliceName¶ Which slice (if profiled).
-
min¶ Minimum occurrences for this link.
-
max¶ Maximum occurrences for this link.
-
description¶ Information about why this link is of interest in this graph definition.
-
target¶ Potential target for the link.
-
-
class
cardea.fhir.GraphDefinition.GraphDefinition_Target(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.
-
type¶ Type of resource this link refers to.
-
profile¶ Profile for the target resource.
-
compartment¶ Compartment Consistency Rules.
-
link¶ Additional links from target resource.
-
cardea.fhir.Group module¶
-
class
cardea.fhir.Group.Group(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized; i.e. a collection of entities that isn’t an Organization.
-
resourceType¶ This is a Group resource
-
identifier¶ A unique business identifier for this group.
-
active¶ Indicates whether the record for the group is available for use or is merely being retained for historical purposes.
-
type¶ Identifies the broad classification of the kind of resources the group includes.
-
actual¶ If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.
-
code¶ Provides a specific type of resource the group includes; e.g. “cow”, “syringe”, etc.
-
name¶ A label assigned to the group for human identification and communication.
-
quantity¶ A count of the number of resource instances that are part of the group.
-
characteristic¶ Identifies the traits shared by members of the group.
-
member¶ Identifies the resource instances that are members of the group.
-
-
class
cardea.fhir.Group.Group_Characteristic(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized; i.e. a collection of entities that isn’t an Organization.
-
code¶ A code that identifies the kind of trait being asserted.
-
valueCodeableConcept¶ The value of the trait that holds (or does not hold - see ‘exclude’) for members of the group.
-
valueBoolean¶ The value of the trait that holds (or does not hold - see ‘exclude’) for members of the group.
-
valueQuantity¶ The value of the trait that holds (or does not hold - see ‘exclude’) for members of the group.
-
valueRange¶ The value of the trait that holds (or does not hold - see ‘exclude’) for members of the group.
-
exclude¶ If true, indicates the characteristic is one that is NOT held by members of the group.
-
period¶ The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.
-
-
class
cardea.fhir.Group.Group_Member(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized; i.e. a collection of entities that isn’t an Organization.
-
entity¶ A reference to the entity that is a member of the group. Must be consistent with Group.type.
-
period¶ The period that the member was in the group, if known.
-
inactive¶ A flag to indicate that the member is no longer in the group, but previously may have been a member.
-
cardea.fhir.GuidanceResponse module¶
-
class
cardea.fhir.GuidanceResponse.GuidanceResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.
-
resourceType¶ This is a GuidanceResponse resource
-
requestId¶ The id of the request associated with this response. If an id was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.
-
identifier¶ Allows a service to provide a unique, business identifier for the response.
-
module¶ A reference to the knowledge module that was invoked.
-
status¶ The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.
-
subject¶ The patient for which the request was processed.
-
context¶ Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.
-
occurrenceDateTime¶ Indicates when the guidance response was processed.
-
performer¶ Provides a reference to the device that performed the guidance.
-
reasonCodeableConcept¶ Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
-
reasonReference¶ Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
-
note¶ Provides a mechanism to communicate additional information about the response.
-
evaluationMessage¶ Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.
-
outputParameters¶ The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.
-
result¶ The actions, if any, produced by the evaluation of the artifact.
-
dataRequirement¶ If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.
-
cardea.fhir.HealthcareService module¶
-
class
cardea.fhir.HealthcareService.HealthcareService(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe details of a healthcare service available at a location.
-
resourceType¶ This is a HealthcareService resource
-
identifier¶ External identifiers for this item.
-
active¶ Whether this healthcareservice record is in active use.
-
providedBy¶ The organization that provides this healthcare service.
-
category¶ Identifies the broad category of service being performed or delivered.
-
type¶ The specific type of service that may be delivered or performed.
-
specialty¶ Collection of specialties handled by the service site. This is more of a medical term.
-
location¶ The location(s) where this healthcare service may be provided.
-
name¶ Further description of the service as it would be presented to a consumer while searching.
-
comment¶ Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.
-
extraDetails¶ Extra details about the service that can’t be placed in the other fields.
-
photo¶ If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
-
telecom¶ List of contacts related to this specific healthcare service.
-
coverageArea¶ The location(s) that this service is available to (not where the service is provided).
-
serviceProvisionCode¶ The code(s) that detail the conditions under which the healthcare service is available/offered.
-
eligibility¶ Does this service have specific eligibility requirements that need to be met in order to use the service?
-
eligibilityNote¶ Describes the eligibility conditions for the service.
-
programName¶ Program Names that can be used to categorize the service.
-
characteristic¶ Collection of characteristics (attributes).
-
referralMethod¶ Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
-
appointmentRequired¶ Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.
-
availableTime¶ A collection of times that the Service Site is available.
-
notAvailable¶ The HealthcareService is not available during this period of time due to the provided reason.
-
availabilityExceptions¶ A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
-
endpoint¶ Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
-
-
class
cardea.fhir.HealthcareService.HealthcareService_AvailableTime(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe details of a healthcare service available at a location.
-
daysOfWeek¶ Indicates which days of the week are available between the start and end Times.
-
allDay¶ Is this always available? (hence times are irrelevant) e.g. 24 hour service.
-
availableStartTime¶ The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
-
availableEndTime¶ The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
-
-
class
cardea.fhir.HealthcareService.HealthcareService_NotAvailable(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe details of a healthcare service available at a location.
-
description¶ The reason that can be presented to the user as to why this time is not available.
-
during¶ Service is not available (seasonally or for a public holiday) from this date.
-
cardea.fhir.HumanName module¶
-
class
cardea.fhir.HumanName.HumanName(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA human’s name with the ability to identify parts and usage.
-
use¶ Identifies the purpose for this name.
-
text¶ A full text representation of the name.
-
family¶ The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
-
given¶ Given name.
-
prefix¶ Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
-
suffix¶ Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
-
period¶ Indicates the period of time when this name was valid for the named person.
-
cardea.fhir.Identifier module¶
-
class
cardea.fhir.Identifier.Identifier(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA technical identifier - identifies some entity uniquely and unambiguously.
-
use¶ The purpose of this identifier.
-
type¶ A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
-
system¶ Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
-
value¶ The portion of the identifier typically relevant to the user and which is unique within the context of the system.
-
period¶ Time period during which identifier is/was valid for use.
-
assigner¶ Organization that issued/manages the identifier.
-
cardea.fhir.ImagingManifest module¶
-
class
cardea.fhir.ImagingManifest.ImagingManifest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.
-
resourceType¶ This is a ImagingManifest resource
-
identifier¶ Unique identifier of the DICOM Key Object Selection (KOS) that this resource represents.
-
patient¶ A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.
Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).
Author of ImagingManifest. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.
-
description¶ Free text narrative description of the ImagingManifest. The value may be derived from the DICOM Standard Part 16, CID-7010 descriptions (e.g. Best in Set, Complete Study Content). Note that those values cover the wide range of uses of the DICOM Key Object Selection object, several of which are not supported by ImagingManifest. Specifically, there is no expected behavior associated with descriptions that suggest referenced images be removed or not used.
-
study¶ Study identity and locating information of the DICOM SOP instances in the selection.
-
-
class
cardea.fhir.ImagingManifest.ImagingManifest_Instance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.
-
sopClass¶ SOP class UID of the selected instance.
-
uid¶ SOP Instance UID of the selected instance.
-
-
class
cardea.fhir.ImagingManifest.ImagingManifest_Series(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.
-
uid¶ Series instance UID of the SOP instances in the selection.
-
endpoint¶ The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.type.
-
instance¶ Identity and locating information of the selected DICOM SOP instances.
-
-
class
cardea.fhir.ImagingManifest.ImagingManifest_Study(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.
-
uid¶ Study instance UID of the SOP instances in the selection.
-
imagingStudy¶ Reference to the Imaging Study in FHIR form.
-
endpoint¶ The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.type.
-
series¶ Series identity and locating information of the DICOM SOP instances in the selection.
-
cardea.fhir.ImagingStudy module¶
-
class
cardea.fhir.ImagingStudy.ImagingStudy(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresentation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.
-
resourceType¶ This is a ImagingStudy resource
-
uid¶ Formal identifier for the study.
-
accession¶ Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).
-
identifier¶ Other identifiers for the study.
-
availability¶ Availability of study (online, offline, or nearline).
-
modalityList¶ A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).
-
patient¶ The patient imaged in the study.
-
context¶ The encounter or episode at which the request is initiated.
-
started¶ Date and time the study started.
-
basedOn¶ A list of the diagnostic requests that resulted in this imaging study being performed.
-
referrer¶ The requesting/referring physician.
-
interpreter¶ Who read the study and interpreted the images or other content.
-
endpoint¶ The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.type.
-
numberOfSeries¶ Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.
-
numberOfInstances¶ Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
-
procedureReference¶ A reference to the performed Procedure.
-
procedureCode¶ The code for the performed procedure type.
-
reason¶ Description of clinical condition indicating why the ImagingStudy was requested.
-
description¶ Institution-generated description or classification of the Study performed.
-
series¶ Each study has one or more series of images or other content.
-
-
class
cardea.fhir.ImagingStudy.ImagingStudy_Instance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresentation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.
-
uid¶ Formal identifier for this image or other content.
-
number¶ The number of instance in the series.
-
sopClass¶ DICOM instance type.
-
title¶ The description of the instance.
-
-
class
cardea.fhir.ImagingStudy.ImagingStudy_Series(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresentation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.
-
uid¶ Formal identifier for this series.
-
number¶ The numeric identifier of this series in the study.
-
modality¶ The modality of this series sequence.
-
description¶ A description of the series.
-
numberOfInstances¶ Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
-
availability¶ Availability of series (online, offline or nearline).
-
endpoint¶ The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.type.
-
bodySite¶ The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.
-
laterality¶ The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.
-
started¶ The date and time the series was started.
-
performer¶ The physician or operator (often the radiology technician) who performed the series. The performer is recorded at the series level, since each series in a study may be performed by a different practitioner, at different times, and using different devices. A series may be performed by multiple practitioners.
-
instance¶ A single SOP instance within the series, e.g. an image, or presentation state.
-
cardea.fhir.Immunization module¶
-
class
cardea.fhir.Immunization.Immunization(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
-
resourceType¶ This is a Immunization resource
-
identifier¶ A unique identifier assigned to this immunization record.
-
status¶ Indicates the current status of the vaccination event.
-
notGiven¶ Indicates if the vaccination was or was not given.
-
vaccineCode¶ Vaccine that was administered or was to be administered.
-
patient¶ The patient who either received or did not receive the immunization.
-
encounter¶ The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
-
date¶ Date vaccine administered or was to be administered.
-
primarySource¶ An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
-
reportOrigin¶ The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
-
location¶ The service delivery location where the vaccine administration occurred.
-
manufacturer¶ Name of vaccine manufacturer.
-
lotNumber¶ Lot number of the vaccine product.
-
expirationDate¶ Date vaccine batch expires.
-
site¶ Body site where vaccine was administered.
-
route¶ The path by which the vaccine product is taken into the body.
-
doseQuantity¶ The quantity of vaccine product that was administered.
-
practitioner¶ Indicates who or what performed the event.
-
note¶ Extra information about the immunization that is not conveyed by the other attributes.
-
explanation¶ Reasons why a vaccine was or was not administered.
-
reaction¶ Categorical data indicating that an adverse event is associated in time to an immunization.
-
vaccinationProtocol¶ Contains information about the protocol(s) under which the vaccine was administered.
-
-
class
cardea.fhir.Immunization.Immunization_Explanation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
-
reason¶ Reasons why a vaccine was administered.
-
reasonNotGiven¶ Reason why a vaccine was not administered.
-
-
class
cardea.fhir.Immunization.Immunization_Practitioner(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
-
role¶ Describes the type of performance (e.g. ordering provider, administering provider, etc.).
-
actor¶ The device, practitioner, etc. who performed the action.
-
-
class
cardea.fhir.Immunization.Immunization_Reaction(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
-
date¶ Date of reaction to the immunization.
-
detail¶ Details of the reaction.
-
reported¶ Self-reported indicator.
-
-
class
cardea.fhir.Immunization.Immunization_VaccinationProtocol(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
-
doseSequence¶ Nominal position in a series.
-
description¶ Contains the description about the protocol under which the vaccine was administered.
Indicates the authority who published the protocol. E.g. ACIP.
-
series¶ One possible path to achieve presumed immunity against a disease - within the context of an authority.
-
seriesDoses¶ The recommended number of doses to achieve immunity.
-
targetDisease¶ The targeted disease.
-
doseStatus¶ Indicates if the immunization event should “count” against the protocol.
-
doseStatusReason¶ Provides an explanation as to why an immunization event should or should not count against the protocol.
-
cardea.fhir.ImmunizationRecommendation module¶
-
class
cardea.fhir.ImmunizationRecommendation.ImmunizationRecommendation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA patient’s point-in-time immunization and recommendation (i.e. forecasting a patient’s immunization eligibility according to a published schedule) with optional supporting justification.
-
resourceType¶ This is a ImmunizationRecommendation resource
-
identifier¶ A unique identifier assigned to this particular recommendation record.
-
patient¶ The patient the recommendations are for.
-
recommendation¶ Vaccine administration recommendations.
-
-
class
cardea.fhir.ImmunizationRecommendation.ImmunizationRecommendation_DateCriterion(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA patient’s point-in-time immunization and recommendation (i.e. forecasting a patient’s immunization eligibility according to a published schedule) with optional supporting justification.
-
code¶ Date classification of recommendation. For example, earliest date to give, latest date to give, etc.
-
value¶ The date whose meaning is specified by dateCriterion.code.
-
-
class
cardea.fhir.ImmunizationRecommendation.ImmunizationRecommendation_Protocol(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA patient’s point-in-time immunization and recommendation (i.e. forecasting a patient’s immunization eligibility according to a published schedule) with optional supporting justification.
-
doseSequence¶ Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.
-
description¶ Contains the description about the protocol under which the vaccine was administered.
Indicates the authority who published the protocol. For example, ACIP.
-
series¶ One possible path to achieve presumed immunity against a disease - within the context of an authority.
-
-
class
cardea.fhir.ImmunizationRecommendation.ImmunizationRecommendation_Recommendation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA patient’s point-in-time immunization and recommendation (i.e. forecasting a patient’s immunization eligibility according to a published schedule) with optional supporting justification.
-
date¶ The date the immunization recommendation was created.
-
vaccineCode¶ Vaccine that pertains to the recommendation.
-
targetDisease¶ The targeted disease for the recommendation.
-
doseNumber¶ The next recommended dose number (e.g. dose 2 is the next recommended dose).
-
forecastStatus¶ Vaccine administration status.
-
dateCriterion¶ Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
-
protocol¶ Contains information about the protocol under which the vaccine was administered.
-
supportingImmunization¶ Immunization event history that supports the status and recommendation.
-
supportingPatientInformation¶ Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.
-
cardea.fhir.ImplementationGuide module¶
-
class
cardea.fhir.ImplementationGuide.ImplementationGuide(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
-
resourceType¶ This is a ImplementationGuide resource
-
url¶ An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published. The URL SHOULD include the major version of the implementation guide. For more information see [Technical and Business Versions](resource.html#versions).
-
version¶ The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
status¶ The status of this implementation guide. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the implementation guide was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.
-
publisher¶ The name of the individual or organization that published the implementation guide.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the implementation guide from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate implementation guide instances.
-
jurisdiction¶ A legal or geographic region in which the implementation guide is intended to be used.
-
copyright¶ A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.
-
fhirVersion¶ The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.1 for this version.
-
dependency¶ Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
-
package¶ A logical group of resources. Logical groups can be used when building pages.
-
global¶ A set of profiles that all resources covered by this implementation guide must conform to.
-
binary¶ A binary file that is included in the implementation guide when it is published.
-
page¶ A page / section in the implementation guide. The root page is the implementation guide home page.
-
-
class
cardea.fhir.ImplementationGuide.ImplementationGuide_Dependency(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
-
type¶ How the dependency is represented when the guide is published.
-
uri¶ Where the dependency is located.
-
-
class
cardea.fhir.ImplementationGuide.ImplementationGuide_Global(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
-
type¶ The type of resource that all instances must conform to.
-
profile¶ A reference to the profile that all instances must conform to.
-
-
class
cardea.fhir.ImplementationGuide.ImplementationGuide_Package(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
-
name¶ The name for the group, as used in page.package.
-
description¶ Human readable text describing the package.
-
resource¶ A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.
-
-
class
cardea.fhir.ImplementationGuide.ImplementationGuide_Page(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
-
source¶ The source address for the page.
-
title¶ A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.
-
kind¶ The kind of page that this is. Some pages are autogenerated (list, example), and other kinds are of interest so that tools can navigate the user to the page of interest.
-
type¶ For constructed pages, what kind of resources to include in the list.
-
package¶ For constructed pages, a list of packages to include in the page (or else empty for everything).
-
format¶ The format of the page.
-
page¶ Nested Pages/Sections under this page.
-
-
class
cardea.fhir.ImplementationGuide.ImplementationGuide_Resource(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
-
example¶ Whether a resource is included in the guide as part of the rules defined by the guide, or just as an example of a resource that conforms to the rules and/or help implementers understand the intent of the guide.
-
name¶ A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).
-
description¶ A description of the reason that a resource has been included in the implementation guide.
-
acronym¶ A short code that may be used to identify the resource throughout the implementation guide.
-
sourceUri¶ Where this resource is found.
-
sourceReference¶ Where this resource is found.
-
exampleFor¶ Another resource that this resource is an example for. This is mostly used for resources that are included as examples of StructureDefinitions.
-
cardea.fhir.Library module¶
-
class
cardea.fhir.Library.Library(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.
-
resourceType¶ This is a Library resource
-
url¶ An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this library is (or will be) published. The URL SHOULD include the major version of the library. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.
-
version¶ The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
-
name¶ A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the library.
-
status¶ The status of this library. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
type¶ Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.
-
date¶ The date (and optionally time) when the library was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.
-
publisher¶ The name of the individual or organization that published the library.
-
description¶ A free text natural language description of the library from a consumer’s perspective.
-
purpose¶ Explaination of why this library is needed and why it has been designed as it has.
-
usage¶ A detailed description of how the library is used from a clinical perspective.
-
approvalDate¶ The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate¶ The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn’t change the original approval date.
-
effectivePeriod¶ The period during which the library content was or is planned to be in active use.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate library instances.
-
jurisdiction¶ A legal or geographic region in which the library is intended to be used.
-
topic¶ Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.
-
contributor¶ A contributor to the content of the library, including authors, editors, reviewers, and endorsers.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
copyright¶ A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.
Related artifacts such as additional documentation, justification, or bibliographic references.
-
parameter¶ The parameter element defines parameters used by the library.
-
dataRequirement¶ Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.
-
content¶ The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.
-
cardea.fhir.Linkage module¶
-
class
cardea.fhir.Linkage.Linkage(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIdentifies two or more records (resource instances) that are referring to the same real-world “occurrence”.
-
resourceType¶ This is a Linkage resource
-
active¶ Indicates whether the asserted set of linkages are considered to be “in effect”.
Identifies the user or organization responsible for asserting the linkages and who establishes the context for evaluating the nature of each linkage.
-
item¶ Identifies one of the records that is considered to refer to the same real-world occurrence as well as how the items hould be evaluated within the collection of linked items.
-
-
class
cardea.fhir.Linkage.Linkage_Item(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIdentifies two or more records (resource instances) that are referring to the same real-world “occurrence”.
-
type¶ Distinguishes which item is “source of truth” (if any) and which items are no longer considered to be current representations.
-
resource¶ The resource instance being linked as part of the group.
-
cardea.fhir.List module¶
-
class
cardea.fhir.List.List(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of information summarized from a list of other resources.
-
resourceType¶ This is a List resource
-
identifier¶ Identifier for the List assigned for business purposes outside the context of FHIR.
-
status¶ Indicates the current state of this list.
-
mode¶ How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
-
title¶ A label for the list assigned by the author.
-
code¶ This code defines the purpose of the list - why it was created.
-
subject¶ The common subject (or patient) of the resources that are in the list, if there is one.
-
encounter¶ The encounter that is the context in which this list was created.
-
date¶ The date that the list was prepared.
-
source¶ The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.
-
orderedBy¶ What order applies to the items in the list.
-
note¶ Comments that apply to the overall list.
-
entry¶ Entries in this list.
-
emptyReason¶ If the list is empty, why the list is empty.
-
-
class
cardea.fhir.List.List_Entry(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of information summarized from a list of other resources.
-
flag¶ The flag allows the system constructing the list to indicate the role and significance of the item in the list.
-
deleted¶ True if this item is marked as deleted in the list.
-
date¶ When this item was added to the list.
-
item¶ A reference to the actual resource from which data was derived.
-
cardea.fhir.Location module¶
-
class
cardea.fhir.Location.Location(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.
-
resourceType¶ This is a Location resource
-
identifier¶ Unique code or number identifying the location to its users.
-
status¶ The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
-
operationalStatus¶ The Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys chair). This typically covers concepts such as contamination, housekeeping and other activities like maintenance.
-
name¶ Name of the location as used by humans. Does not need to be unique.
-
alias¶ A list of alternate names that the location is known as, or was known as in the past.
-
description¶ Description of the Location, which helps in finding or referencing the place.
-
mode¶ Indicates whether a resource instance represents a specific location or a class of locations.
-
type¶ Indicates the type of function performed at the location.
-
telecom¶ The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
-
address¶ Physical location.
-
physicalType¶ Physical form of the location, e.g. building, room, vehicle, road.
-
position¶ The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
-
managingOrganization¶ The organization responsible for the provisioning and upkeep of the location.
-
partOf¶ Another Location which this Location is physically part of.
-
endpoint¶ Technical endpoints providing access to services operated for the location.
-
-
class
cardea.fhir.Location.Location_Position(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.
-
longitude¶ Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
-
latitude¶ Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
-
altitude¶ Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).
-
cardea.fhir.Measure module¶
-
class
cardea.fhir.Measure.Measure(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Measure resource provides the definition of a quality measure.
-
resourceType¶ This is a Measure resource
-
url¶ An absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this measure is (or will be) published. The URL SHOULD include the major version of the measure. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
-
name¶ A natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the measure.
-
status¶ The status of this measure. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the measure was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes.
-
publisher¶ The name of the individual or organization that published the measure.
-
description¶ A free text natural language description of the measure from a consumer’s perspective.
-
purpose¶ Explaination of why this measure is needed and why it has been designed as it has.
-
usage¶ A detailed description of how the measure is used from a clinical perspective.
-
approvalDate¶ The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate¶ The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn’t change the original approval date.
-
effectivePeriod¶ The period during which the measure content was or is planned to be in active use.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate measure instances.
-
jurisdiction¶ A legal or geographic region in which the measure is intended to be used.
-
topic¶ Descriptive topics related to the content of the measure. Topics provide a high-level categorization of the type of the measure that can be useful for filtering and searching.
-
contributor¶ A contributor to the content of the measure, including authors, editors, reviewers, and endorsers.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
copyright¶ A copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.
Related artifacts such as additional documentation, justification, or bibliographic references.
-
library¶ A reference to a Library resource containing the formal logic used by the measure.
-
disclaimer¶ Notices and disclaimers regarding the use of the measure, or related to intellectual property (such as code systems) referenced by the measure.
-
scoring¶ Indicates how the calculation is performed for the measure, including proportion, ratio, continuous variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.
-
compositeScoring¶ If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.
-
type¶ Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.
-
riskAdjustment¶ A description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results.
-
rateAggregation¶ Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.
-
rationale¶ Provides a succint statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.
-
clinicalRecommendationStatement¶ Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
-
improvementNotation¶ Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is whthin a range).
-
definition¶ Provides a description of an individual term used within the measure.
-
guidance¶ Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.
-
set¶ The measure set, e.g. Preventive Care and Screening.
-
group¶ A group of population criteria for the measure.
-
supplementalData¶ The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.
-
-
class
cardea.fhir.Measure.Measure_Group(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Measure resource provides the definition of a quality measure.
-
identifier¶ A unique identifier for the group. This identifier will used to report data for the group in the measure report.
-
name¶ Optional name or short description of this group.
-
description¶ The human readable description of this population group.
-
population¶ A population criteria for the measure.
-
stratifier¶ The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library, or a valid FHIR Resource Path.
-
-
class
cardea.fhir.Measure.Measure_Population(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Measure resource provides the definition of a quality measure.
-
identifier¶ A unique identifier for the population criteria. This identifier is used to report data against this criteria within the measure report.
-
code¶ The type of population criteria.
-
name¶ Optional name or short description of this population.
-
description¶ The human readable description of this population criteria.
-
criteria¶ The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria.
-
-
class
cardea.fhir.Measure.Measure_Stratifier(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Measure resource provides the definition of a quality measure.
-
identifier¶ The identifier for the stratifier used to coordinate the reported data back to this stratifier.
-
criteria¶ The criteria for the stratifier. This must be the name of an expression defined within a referenced library.
-
path¶ The path to an element that defines the stratifier, specified as a valid FHIR resource path.
-
-
class
cardea.fhir.Measure.Measure_SupplementalData(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Measure resource provides the definition of a quality measure.
-
identifier¶ An identifier for the supplemental data.
-
usage¶ An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation.
-
criteria¶ The criteria for the supplemental data. This must be the name of a valid expression defined within a referenced library, and defines the data to be returned for this element.
-
path¶ The supplemental data to be supplied as part of the measure response, specified as a valid FHIR Resource Path.
-
cardea.fhir.MeasureReport module¶
-
class
cardea.fhir.MeasureReport.MeasureReport(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe MeasureReport resource contains the results of evaluating a measure.
-
resourceType¶ This is a MeasureReport resource
-
identifier¶ A formal identifier that is used to identify this report when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
status¶ The report status. No data will be available until the report status is complete.
-
type¶ The type of measure report. This may be an individual report, which provides a single patient’s score for the measure; a patient listing, which returns the list of patients that meet the various criteria in the measure; or a summary report, which returns a population count for each of the criteria in the measure.
-
measure¶ A reference to the Measure that was evaluated to produce this report.
-
patient¶ Optional Patient if the report was requested for a single patient.
-
date¶ The date this measure report was generated.
-
reportingOrganization¶ Reporting Organization.
-
period¶ The reporting period for which the report was calculated.
-
group¶ The results of the calculation, one for each population group in the measure.
-
evaluatedResources¶ A reference to a Bundle containing the Resources that were used in the evaluation of this report.
-
-
class
cardea.fhir.MeasureReport.MeasureReport_Group(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe MeasureReport resource contains the results of evaluating a measure.
-
identifier¶ The identifier of the population group as defined in the measure definition.
-
population¶ The populations that make up the population group, one for each type of population appropriate for the measure.
-
measureScore¶ The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.
-
stratifier¶ When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.
-
-
class
cardea.fhir.MeasureReport.MeasureReport_Population(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe MeasureReport resource contains the results of evaluating a measure.
-
identifier¶ The identifier of the population being reported, as defined by the population element of the measure.
-
code¶ The type of the population.
-
count¶ The number of members of the population.
-
patients¶ This element refers to a List of patient level MeasureReport resources, one for each patient in this population.
-
-
class
cardea.fhir.MeasureReport.MeasureReport_Population1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe MeasureReport resource contains the results of evaluating a measure.
-
identifier¶ The identifier of the population being reported, as defined by the population element of the measure.
-
code¶ The type of the population.
-
count¶ The number of members of the population in this stratum.
-
patients¶ This element refers to a List of patient level MeasureReport resources, one for each patient in this population in this stratum.
-
-
class
cardea.fhir.MeasureReport.MeasureReport_Stratifier(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe MeasureReport resource contains the results of evaluating a measure.
-
identifier¶ The identifier of this stratifier, as defined in the measure definition.
-
stratum¶ This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.
-
-
class
cardea.fhir.MeasureReport.MeasureReport_Stratum(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe MeasureReport resource contains the results of evaluating a measure.
-
value¶ The value for this stratum, expressed as a string. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.
-
population¶ The populations that make up the stratum, one for each type of population appropriate to the measure.
-
measureScore¶ The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.
-
cardea.fhir.Media module¶
-
class
cardea.fhir.Media.Media(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
-
resourceType¶ This is a Media resource
-
identifier¶ Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.
-
basedOn¶ A procedure that is fulfilled in whole or in part by the creation of this media.
-
type¶ Whether the media is a photo (still image), an audio recording, or a video recording.
-
subtype¶ Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.
-
view¶ The name of the imaging view e.g. Lateral or Antero-posterior (AP).
-
subject¶ Who/What this Media is a record of.
-
context¶ The encounter or episode of care that establishes the context for this media.
-
occurrenceDateTime¶ The date and time(s) at which the media was collected.
-
occurrencePeriod¶ The date and time(s) at which the media was collected.
-
operator¶ The person who administered the collection of the image.
-
reasonCode¶ Describes why the event occurred in coded or textual form.
-
bodySite¶ Indicates the site on the subject’s body where the media was collected (i.e. the target site).
-
device¶ The device used to collect the media.
-
height¶ Height of the image in pixels (photo/video).
-
width¶ Width of the image in pixels (photo/video).
-
frames¶ The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
-
duration¶ The duration of the recording in seconds - for audio and video.
-
content¶ The actual content of the media - inline or by direct reference to the media source file.
-
note¶ Comments made about the media by the performer, subject or other participants.
-
cardea.fhir.Medication module¶
-
class
cardea.fhir.Medication.Medication(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.
-
resourceType¶ This is a Medication resource
-
code¶ A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
-
status¶ A code to indicate if the medication is in active use.
-
isBrand¶ Set to true if the item is attributable to a specific manufacturer.
-
isOverTheCounter¶ Set to true if the medication can be obtained without an order from a prescriber.
-
manufacturer¶ Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
-
form¶ Describes the form of the item. Powder; tablets; capsule.
-
ingredient¶ Identifies a particular constituent of interest in the product.
-
package¶ Information that only applies to packages (not products).
-
image¶ Photo(s) or graphic representation(s) of the medication.
-
-
class
cardea.fhir.Medication.Medication_Batch(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.
-
lotNumber¶ The assigned lot number of a batch of the specified product.
-
expirationDate¶ When this specific batch of product will expire.
-
-
class
cardea.fhir.Medication.Medication_Content(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.
-
itemCodeableConcept¶ Identifies one of the items in the package.
-
itemReference¶ Identifies one of the items in the package.
-
amount¶ The amount of the product that is in the package.
-
-
class
cardea.fhir.Medication.Medication_Ingredient(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.
-
itemCodeableConcept¶ The actual ingredient - either a substance (simple ingredient) or another medication.
-
itemReference¶ The actual ingredient - either a substance (simple ingredient) or another medication.
-
isActive¶ Indication of whether this ingredient affects the therapeutic action of the drug.
-
amount¶ Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.
-
-
class
cardea.fhir.Medication.Medication_Package(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.
-
container¶ The kind of container that this package comes as.
-
content¶ A set of components that go to make up the described item.
-
batch¶ Information about a group of medication produced or packaged from one production run.
-
cardea.fhir.MedicationAdministration module¶
-
class
cardea.fhir.MedicationAdministration.MedicationAdministration(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.
-
resourceType¶ This is a MedicationAdministration resource
-
identifier¶ External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.
-
definition¶ A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event.
-
partOf¶ A larger event of which this particular event is a component or step.
-
status¶ Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
-
category¶ Indicates the type of medication administration and where the medication is expected to be consumed or administered.
-
medicationCodeableConcept¶ Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
-
medicationReference¶ Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
-
subject¶ The person or animal or group receiving the medication.
-
context¶ The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.
-
supportingInformation¶ Additional information (for example, patient height and weight) that supports the administration of the medication.
-
effectiveDateTime¶ A specific date/time or interval of time during which the administration took place (or did not take place, when the ‘notGiven’ attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
-
effectivePeriod¶ A specific date/time or interval of time during which the administration took place (or did not take place, when the ‘notGiven’ attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
-
performer¶ The individual who was responsible for giving the medication to the patient.
-
notGiven¶ Set this to true if the record is saying that the medication was NOT administered.
-
reasonNotGiven¶ A code indicating why the administration was not performed.
-
reasonCode¶ A code indicating why the medication was given.
-
reasonReference¶ Condition or observation that supports why the medication was administered.
-
prescription¶ The original request, instruction or authority to perform the administration.
-
device¶ The device used in administering the medication to the patient. For example, a particular infusion pump.
-
note¶ Extra information about the medication administration that is not conveyed by the other attributes.
-
dosage¶ Describes the medication dosage information details e.g. dose, rate, site, route, etc.
-
eventHistory¶ A summary of the events of interest that have occurred, such as when the administration was verified.
-
-
class
cardea.fhir.MedicationAdministration.MedicationAdministration_Dosage(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.
-
text¶ Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans. The dosage instructions should reflect the dosage of the medication that was administered.
-
site¶ A coded specification of the anatomic site where the medication first entered the body. For example, “left arm”.
-
route¶ A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.
-
method¶ A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.
-
dose¶ The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.
-
rateRatio¶ Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.
-
rateSimpleQuantity¶ Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.
-
-
class
cardea.fhir.MedicationAdministration.MedicationAdministration_Performer(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.
-
actor¶ The device, practitioner, etc. who performed the action.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
cardea.fhir.MedicationDispense module¶
-
class
cardea.fhir.MedicationDispense.MedicationDispense(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIndicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
-
resourceType¶ This is a MedicationDispense resource
-
identifier¶ Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.
-
partOf¶ The procedure that the dispense is done because of.
-
status¶ A code specifying the state of the set of dispense events.
-
category¶ Indicates type of medication dispense and where the medication is expected to be consumed or administered.
-
medicationCodeableConcept¶ Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
-
medicationReference¶ Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
-
subject¶ A link to a resource representing the person or the group to whom the medication will be given.
-
context¶ The encounter or episode of care that establishes the context for this event.
-
supportingInformation¶ Additional information that supports the medication being dispensed.
-
performer¶ Indicates who or what performed the event. It should be assumed that the performer is the dispenser of the medication.
Indicates the medication order that is being dispensed against.
-
type¶ Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
-
quantity¶ The amount of medication that has been dispensed. Includes unit of measure.
-
daysSupply¶ The amount of medication expressed as a timing amount.
-
whenPrepared¶ The time when the dispensed product was packaged and reviewed.
-
whenHandedOver¶ The time the dispensed product was provided to the patient or their representative.
-
destination¶ Identification of the facility/location where the medication was shipped to, as part of the dispense event.
-
receiver¶ Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.
-
note¶ Extra information about the dispense that could not be conveyed in the other attributes.
-
dosageInstruction¶ Indicates how the medication is to be used by the patient.
-
substitution¶ Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.
-
detectedIssue¶ Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.
-
notDone¶ True if the dispense was not performed for some reason.
-
notDoneReasonCodeableConcept¶ Indicates the reason why a dispense was not performed.
-
notDoneReasonReference¶ Indicates the reason why a dispense was not performed.
-
eventHistory¶ A summary of the events of interest that have occurred, such as when the dispense was verified.
-
-
class
cardea.fhir.MedicationDispense.MedicationDispense_Performer(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIndicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
-
actor¶ The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
-
class
cardea.fhir.MedicationDispense.MedicationDispense_Substitution(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIndicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
-
wasSubstituted¶ True if the dispenser dispensed a different drug or product from what was prescribed.
-
type¶ A code signifying whether a different drug was dispensed from what was prescribed.
-
reason¶ Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.
-
responsibleParty¶ The person or organization that has primary responsibility for the substitution.
-
cardea.fhir.MedicationRequest module¶
-
class
cardea.fhir.MedicationRequest.MedicationRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called “MedicationRequest” rather than “MedicationPrescription” or “MedicationOrder” to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.
-
resourceType¶ This is a MedicationRequest resource
-
identifier¶ This records identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. For example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records must be tracked through an entire system.
-
definition¶ Protocol or definition followed by this request.
-
basedOn¶ A plan or request that is fulfilled in whole or in part by this medication request.
-
groupIdentifier¶ A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.
-
status¶ A code specifying the current state of the order. Generally this will be active or completed state.
-
intent¶ Whether the request is a proposal, plan, or an original order.
-
category¶ Indicates the type of medication order and where the medication is expected to be consumed or administered.
-
priority¶ Indicates how quickly the Medication Request should be addressed with respect to other requests.
-
medicationCodeableConcept¶ Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
-
medicationReference¶ Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
-
subject¶ A link to a resource representing the person or set of individuals to whom the medication will be given.
-
context¶ A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.
-
supportingInformation¶ Include additional information (for example, patient height and weight) that supports the ordering of the medication.
The date (and perhaps time) when the prescription was initially written or authored on.
-
requester¶ The individual, organization or device that initiated the request and has responsibility for its activation.
-
recorder¶ The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
-
reasonCode¶ The reason or the indication for ordering the medication.
-
reasonReference¶ Condition or observation that supports why the medication was ordered.
-
note¶ Extra information about the prescription that could not be conveyed by the other attributes.
-
dosageInstruction¶ Indicates how the medication is to be used by the patient.
-
dispenseRequest¶ Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
-
substitution¶ Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen. This block explains the prescriber’s intent. If nothing is specified substitution may be done.
-
priorPrescription¶ A link to a resource representing an earlier order related order or prescription.
-
detectedIssue¶ Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.
-
eventHistory¶ Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.
-
-
class
cardea.fhir.MedicationRequest.MedicationRequest_DispenseRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called “MedicationRequest” rather than “MedicationPrescription” or “MedicationOrder” to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.
-
validityPeriod¶ This indicates the validity period of a prescription (stale dating the Prescription).
-
numberOfRepeatsAllowed¶ An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus “3 repeats”, then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets.
-
quantity¶ The amount that is to be dispensed for one fill.
-
expectedSupplyDuration¶ Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.
-
performer¶ Indicates the intended dispensing Organization specified by the prescriber.
-
-
class
cardea.fhir.MedicationRequest.MedicationRequest_Requester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called “MedicationRequest” rather than “MedicationPrescription” or “MedicationOrder” to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.
-
agent¶ The healthcare professional responsible for authorizing the initial prescription.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
-
class
cardea.fhir.MedicationRequest.MedicationRequest_Substitution(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called “MedicationRequest” rather than “MedicationPrescription” or “MedicationOrder” to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.
-
allowed¶ True if the prescriber allows a different drug to be dispensed from what was prescribed.
-
reason¶ Indicates the reason for the substitution, or why substitution must or must not be performed.
-
cardea.fhir.MedicationStatement module¶
-
class
cardea.fhir.MedicationStatement.MedicationStatement(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now, or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient’s memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient’s memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.
-
resourceType¶ This is a MedicationStatement resource
-
identifier¶ External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.
-
basedOn¶ A plan, proposal or order that is fulfilled in whole or in part by this event.
-
partOf¶ A larger event of which this particular event is a component or step.
-
context¶ The encounter or episode of care that establishes the context for this MedicationStatement.
-
status¶ A code representing the patient or other source’s judgment about the state of the medication used that this statement is about. Generally this will be active or completed.
-
category¶ Indicates where type of medication statement and where the medication is expected to be consumed or administered.
-
medicationCodeableConcept¶ Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
-
medicationReference¶ Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
-
effectiveDateTime¶ The interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the wasNotGiven element is true).
-
effectivePeriod¶ The interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the wasNotGiven element is true).
-
dateAsserted¶ The date when the medication statement was asserted by the information source.
-
informationSource¶ The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g Claim or MedicationRequest.
-
subject¶ The person, animal or group who is/was taking the medication.
-
derivedFrom¶ Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.
-
taken¶ Indicator of the certainty of whether the medication was taken by the patient.
-
reasonNotTaken¶ A code indicating why the medication was not taken.
-
reasonCode¶ A reason for why the medication is being/was taken.
-
reasonReference¶ Condition or observation that supports why the medication is being/was taken.
-
note¶ Provides extra information about the medication statement that is not conveyed by the other attributes.
-
dosage¶ Indicates how the medication is/was or should be taken by the patient.
-
cardea.fhir.MessageDefinition module¶
-
class
cardea.fhir.MessageDefinition.MessageDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDefines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
-
resourceType¶ This is a MessageDefinition resource
-
url¶ An absolute URI that is used to identify this message definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this message definition is (or will be) published. The URL SHOULD include the major version of the message definition. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the message definition.
-
status¶ The status of this message definition. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the message definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes.
-
publisher¶ The name of the individual or organization that published the message definition.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the message definition from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate message definition instances.
-
jurisdiction¶ A legal or geographic region in which the message definition is intended to be used.
-
purpose¶ Explaination of why this message definition is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.
-
base¶ The MessageDefinition that is the basis for the contents of this resource.
-
parent¶ Identifies a protocol or workflow that this MessageDefinition represents a step in.
-
replaces¶ A MessageDefinition that is superseded by this definition.
-
event¶ A coded identifier of a supported messaging event.
-
category¶ The impact of the content of the message.
-
focus¶ Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.
-
responseRequired¶ Indicates whether a response is required for this message.
-
allowedResponse¶ Indicates what types of messages may be sent as an application-level response to this message.
-
-
class
cardea.fhir.MessageDefinition.MessageDefinition_AllowedResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDefines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
-
message¶ A reference to the message definition that must be adhered to by this supported response.
-
situation¶ Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).
-
-
class
cardea.fhir.MessageDefinition.MessageDefinition_Focus(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDefines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
-
code¶ The kind of resource that must be the focus for this message.
-
profile¶ A profile that reflects constraints for the focal resource (and potentially for related resources).
-
min¶ Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.
-
max¶ Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.
-
cardea.fhir.MessageHeader module¶
-
class
cardea.fhir.MessageHeader.MessageHeader(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
-
resourceType¶ This is a MessageHeader resource
-
event¶ Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value “http://hl7.org/fhir/message-events”.
-
destination¶ The destination application which the message is intended for.
-
receiver¶ Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn’t sufficient.
-
sender¶ Identifies the sending system to allow the use of a trust relationship.
-
timestamp¶ The time that the message was sent.
-
enterer¶ The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.
The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.
-
source¶ The source application from which this message originated.
-
responsible¶ The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.
-
reason¶ Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
-
response¶ Information about the message that this message is a response to. Only present if this message is a response.
-
focus¶ The actual data of the message - a reference to the root/focus class of the event.
-
-
class
cardea.fhir.MessageHeader.MessageHeader_Destination(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
-
name¶ Human-readable name for the target system.
-
target¶ Identifies the target end system in situations where the initial message transmission is to an intermediary system.
-
endpoint¶ Indicates where the message should be routed to.
-
-
class
cardea.fhir.MessageHeader.MessageHeader_Response(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
-
identifier¶ The MessageHeader.id of the message to which this message is a response.
-
code¶ Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.
-
details¶ Full details of any issues found in the message.
-
-
class
cardea.fhir.MessageHeader.MessageHeader_Source(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
-
name¶ Human-readable name for the source system.
-
software¶ May include configuration or other information useful in debugging.
-
version¶ Can convey versions of multiple systems in situations where a message passes through multiple hands.
-
contact¶ An e-mail, phone, website or other contact point to use to resolve issues with message communications.
-
endpoint¶ Identifies the routing target to send acknowledgements to.
-
cardea.fhir.Meta module¶
-
class
cardea.fhir.Meta.Meta(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
-
versionId¶ The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.
-
lastUpdated¶ When the resource last changed - e.g. when the version changed.
-
profile¶ A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
-
security¶ Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
-
tag¶ Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
-
cardea.fhir.Money module¶
-
class
cardea.fhir.Money.Money(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn amount of economic utility in some recognized currency.
cardea.fhir.NamingSystem module¶
-
class
cardea.fhir.NamingSystem.NamingSystem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a “System” used within the Identifier and Coding data types.
-
resourceType¶ This is a NamingSystem resource
-
name¶ A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
status¶ The status of this naming system. Enables tracking the life-cycle of the content.
-
kind¶ Indicates the purpose for the naming system - what kinds of things does it make unique?
-
date¶ The date (and optionally time) when the naming system was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.
-
publisher¶ The name of the individual or organization that published the naming system.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
responsible¶ The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
-
type¶ Categorizes a naming system for easier search by grouping related naming systems.
-
description¶ A free text natural language description of the naming system from a consumer’s perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate naming system instances.
-
jurisdiction¶ A legal or geographic region in which the naming system is intended to be used.
-
usage¶ Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
-
uniqueId¶ Indicates how the system may be identified when referenced in electronic exchange.
-
replacedBy¶ For naming systems that are retired, indicates the naming system that should be used in their place (if any).
-
-
class
cardea.fhir.NamingSystem.NamingSystem_UniqueId(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a “System” used within the Identifier and Coding data types.
-
type¶ Identifies the unique identifier scheme used for this particular identifier.
-
value¶ The string that should be sent over the wire to identify the code system or identifier system.
-
preferred¶ Indicates whether this identifier is the “preferred” identifier of this type.
-
comment¶ Notes about the past or intended usage of this identifier.
-
period¶ Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.
-
cardea.fhir.Narrative module¶
-
class
cardea.fhir.Narrative.Narrative(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA human-readable formatted text, including images.
-
status¶ The status of the narrative - whether it’s entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
-
div¶ The actual narrative content, a stripped down version of XHTML.
-
cardea.fhir.NutritionOrder module¶
-
class
cardea.fhir.NutritionOrder.NutritionOrder(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
-
resourceType¶ This is a NutritionOrder resource
-
identifier¶ Identifiers assigned to this order by the order sender or by the order receiver.
-
status¶ The workflow status of the nutrition order/request.
-
patient¶ The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
-
encounter¶ An encounter that provides additional information about the healthcare context in which this request is made.
-
dateTime¶ The date and time that this nutrition order was requested.
-
orderer¶ The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
-
allergyIntolerance¶ A link to a record of allergies or intolerances which should be included in the nutrition order.
-
foodPreferenceModifier¶ This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.
-
excludeFoodModifier¶ This modifier is used to convey order-specific modifiers about the type of food that should NOT be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced AllergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient’s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.
-
oralDiet¶ Diet given orally in contrast to enteral (tube) feeding.
-
supplement¶ Oral nutritional products given in order to add further nutritional value to the patient’s diet.
-
enteralFormula¶ Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.
-
-
class
cardea.fhir.NutritionOrder.NutritionOrder_Administration(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
-
schedule¶ The time period and frequency at which the enteral formula should be delivered to the patient.
-
quantity¶ The volume of formula to provide to the patient per the specified administration schedule.
-
rateSimpleQuantity¶ The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.
-
rateRatio¶ The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.
-
-
class
cardea.fhir.NutritionOrder.NutritionOrder_EnteralFormula(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
-
baseFormulaType¶ The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.
-
baseFormulaProductName¶ The product or brand name of the enteral or infant formula product such as “ACME Adult Standard Formula”.
-
additiveType¶ Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula.
-
additiveProductName¶ The product or brand name of the type of modular component to be added to the formula.
-
caloricDensity¶ The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula that provides 24 calories per fluid ounce or an adult may require an enteral formula that provides 1.5 calorie/mL.
-
routeofAdministration¶ The route or physiological path of administration into the patient’s gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.
-
administration¶ Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.
-
maxVolumeToDeliver¶ The maximum total quantity of formula that may be administered to a subject over the period of time, e.g. 1440 mL over 24 hours.
-
administrationInstruction¶ Free text formula administration, feeding instructions or additional instructions or information.
-
-
class
cardea.fhir.NutritionOrder.NutritionOrder_Nutrient(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
-
modifier¶ The nutrient that is being modified such as carbohydrate or sodium.
-
amount¶ The quantity of the specified nutrient to include in diet.
-
-
class
cardea.fhir.NutritionOrder.NutritionOrder_OralDiet(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
-
type¶ The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.
-
schedule¶ The time period and frequency at which the diet should be given. The diet should be given for the combination of all schedules if more than one schedule is present.
-
nutrient¶ Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.
-
texture¶ Class that describes any texture modifications required for the patient to safely consume various types of solid foods.
-
fluidConsistencyType¶ The required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient.
-
instruction¶ Free text or additional instructions or information pertaining to the oral diet.
-
-
class
cardea.fhir.NutritionOrder.NutritionOrder_Supplement(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
-
type¶ The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.
-
productName¶ The product or brand name of the nutritional supplement such as “Acme Protein Shake”.
-
schedule¶ The time period and frequency at which the supplement(s) should be given. The supplement should be given for the combination of all schedules if more than one schedule is present.
-
quantity¶ The amount of the nutritional supplement to be given.
-
instruction¶ Free text or additional instructions or information pertaining to the oral supplement.
-
-
class
cardea.fhir.NutritionOrder.NutritionOrder_Texture(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
-
modifier¶ Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed.
-
foodType¶ The food type(s) (e.g. meats, all foods) that the texture modification applies to. This could be all foods types.
-
cardea.fhir.Observation module¶
-
class
cardea.fhir.Observation.Observation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseMeasurements and simple assertions made about a patient, device or other subject.
-
resourceType¶ This is a Observation resource
-
identifier¶ A unique identifier assigned to this observation.
-
basedOn¶ A plan, proposal or order that is fulfilled in whole or in part by this event.
-
status¶ The status of the result value.
-
category¶ A code that classifies the general type of observation being made.
-
code¶ Describes what was observed. Sometimes this is called the observation “name”.
-
subject¶ The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.
-
context¶ The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
-
effectiveDateTime¶ The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the “physiologically relevant time”. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
-
effectivePeriod¶ The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the “physiologically relevant time”. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
-
issued¶ The date and time this observation was made available to providers, typically after the results have been reviewed and verified.
-
performer¶ Who was responsible for asserting the observed value as “true”.
-
valueQuantity¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueCodeableConcept¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueString¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueBoolean¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueRange¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueRatio¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueSampledData¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueAttachment¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueTime¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueDateTime¶ The information determined as a result of making the observation, if the information has a simple value.
-
valuePeriod¶ The information determined as a result of making the observation, if the information has a simple value.
-
dataAbsentReason¶ Provides a reason why the expected value in the element Observation.value[x] is missing.
-
interpretation¶ The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
-
comment¶ May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.
-
bodySite¶ Indicates the site on the subject’s body where the observation was made (i.e. the target site).
-
method¶ Indicates the mechanism used to perform the observation.
-
specimen¶ The specimen that was used when this observation was made.
-
device¶ The device used to generate the observation data.
-
referenceRange¶ Guidance on how to interpret the value by comparison to a normal or recommended range.
A reference to another resource (usually another Observation) whose relationship is defined by the relationship type code.
-
component¶ Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
-
-
class
cardea.fhir.Observation.Observation_Component(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseMeasurements and simple assertions made about a patient, device or other subject.
-
code¶ Describes what was observed. Sometimes this is called the observation “code”.
-
valueQuantity¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueCodeableConcept¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueString¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueRange¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueRatio¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueSampledData¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueAttachment¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueTime¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueDateTime¶ The information determined as a result of making the observation, if the information has a simple value.
-
valuePeriod¶ The information determined as a result of making the observation, if the information has a simple value.
-
dataAbsentReason¶ Provides a reason why the expected value in the element Observation.value[x] is missing.
-
interpretation¶ The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
-
referenceRange¶ Guidance on how to interpret the value by comparison to a normal or recommended range.
-
-
class
cardea.fhir.Observation.Observation_ReferenceRange(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseMeasurements and simple assertions made about a patient, device or other subject.
-
low¶ The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).
-
high¶ The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).
-
type¶ Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.
-
appliesTo¶ Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race.
-
age¶ The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.
-
text¶ Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of “Negative” or a list or table of ‘normals’.
-
-
class
cardea.fhir.Observation.Observation_Related(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseMeasurements and simple assertions made about a patient, device or other subject.
-
type¶ A code specifying the kind of relationship that exists with the target resource.
-
target¶ A reference to the observation or [[[QuestionnaireResponse]]] resource that is related to this observation.
-
cardea.fhir.OperationDefinition module¶
-
class
cardea.fhir.OperationDefinition.OperationDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
-
resourceType¶ This is a OperationDefinition resource
-
url¶ An absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published. The URL SHOULD include the major version of the operation definition. For more information see [Technical and Business Versions](resource.html#versions).
-
version¶ The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
status¶ The status of this operation definition. Enables tracking the life-cycle of the content.
-
kind¶ Whether this is an operation or a named query.
-
experimental¶ A boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the operation definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.
-
publisher¶ The name of the individual or organization that published the operation definition.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the operation definition from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate operation definition instances.
-
jurisdiction¶ A legal or geographic region in which the operation definition is intended to be used.
-
purpose¶ Explaination of why this operation definition is needed and why it has been designed as it has.
-
idempotent¶ Operations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.
-
code¶ The name used to invoke the operation.
-
comment¶ Additional information about how to use this operation or named query.
-
base¶ Indicates that this operation definition is a constraining profile on the base.
-
resource¶ The types on which this operation can be executed.
-
system¶ Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).
-
type¶ Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).
-
instance¶ Indicates whether this operation can be invoked on a particular instance of one of the given types.
-
parameter¶ The parameters for the operation/query.
-
overload¶ Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.
-
-
class
cardea.fhir.OperationDefinition.OperationDefinition_Binding(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
-
strength¶ Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.
-
valueSetUri¶ Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.
-
valueSetReference¶ Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.
-
-
class
cardea.fhir.OperationDefinition.OperationDefinition_Overload(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
-
parameterName¶ Name of parameter to include in overload.
-
comment¶ Comments to go on overload.
-
-
class
cardea.fhir.OperationDefinition.OperationDefinition_Parameter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
-
name¶ The name of used to identify the parameter.
-
use¶ Whether this is an input or an output parameter.
-
min¶ The minimum number of times this parameter SHALL appear in the request or response.
-
max¶ The maximum number of times this element is permitted to appear in the request or response.
-
documentation¶ Describes the meaning or use of this parameter.
-
type¶ The type for this parameter.
-
searchType¶ How the parameter is understood as a search parameter. This is only used if the parameter type is ‘string’.
-
profile¶ A profile the specifies the rules that this parameter must conform to.
-
binding¶ Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).
-
part¶ The parts of a nested Parameter.
-
cardea.fhir.OperationOutcome module¶
-
class
cardea.fhir.OperationOutcome.OperationOutcome(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA collection of error, warning or information messages that result from a system action.
-
resourceType¶ This is a OperationOutcome resource
-
issue¶ An error, warning or information message that results from a system action.
-
-
class
cardea.fhir.OperationOutcome.OperationOutcome_Issue(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA collection of error, warning or information messages that result from a system action.
-
severity¶ Indicates whether the issue indicates a variation from successful processing.
-
code¶ Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.
-
details¶ Additional details about the error. This may be a text description of the error, or a system code that identifies the error.
-
diagnostics¶ Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stack dump to help trace the issue.
-
location¶ For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be “http.” + the parameter name.
-
expression¶ A simple FHIRPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.
-
cardea.fhir.Organization module¶
-
class
cardea.fhir.Organization.Organization(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.
-
resourceType¶ This is a Organization resource
-
identifier¶ Identifier for the organization that is used to identify the organization across multiple disparate systems.
-
active¶ Whether the organization’s record is still in active use.
-
type¶ The kind(s) of organization that this is.
-
name¶ A name associated with the organization.
-
alias¶ A list of alternate names that the organization is known as, or was known as in the past.
-
telecom¶ A contact detail for the organization.
-
address¶ An address for the organization.
-
partOf¶ The organization of which this organization forms a part.
-
contact¶ Contact for the organization for a certain purpose.
-
endpoint¶ Technical endpoints providing access to services operated for the organization.
-
-
class
cardea.fhir.Organization.Organization_Contact(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.
-
purpose¶ Indicates a purpose for which the contact can be reached.
-
name¶ A name associated with the contact.
-
telecom¶ A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
-
address¶ Visiting or postal addresses for the contact.
-
cardea.fhir.ParameterDefinition module¶
-
class
cardea.fhir.ParameterDefinition.ParameterDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.
-
name¶ The name of the parameter used to allow access to the value of the parameter in evaluation contexts.
-
use¶ Whether the parameter is input or output for the module.
-
min¶ The minimum number of times this parameter SHALL appear in the request or response.
-
max¶ The maximum number of times this element is permitted to appear in the request or response.
-
documentation¶ A brief discussion of what the parameter is for and how it is used by the module.
-
type¶ The type of the parameter.
-
profile¶ If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
-
cardea.fhir.Parameters module¶
-
class
cardea.fhir.Parameters.Parameters(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis special resource type is used to represent an operation request and response (operations.html). It has no other use, and there is no RESTful endpoint associated with it.
-
parameter¶ A parameter passed to or received from the operation.
-
-
class
cardea.fhir.Parameters.Parameters_Parameter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis special resource type is used to represent an operation request and response (operations.html). It has no other use, and there is no RESTful endpoint associated with it.
-
name¶ The name of the parameter (reference to the operation definition).
-
valueBoolean¶ If the parameter is a data type.
-
valueInteger¶ If the parameter is a data type.
-
valueDecimal¶ If the parameter is a data type.
-
valueBase64Binary¶ If the parameter is a data type.
-
valueInstant¶ If the parameter is a data type.
-
valueString¶ If the parameter is a data type.
-
valueUri¶ If the parameter is a data type.
-
valueDate¶ If the parameter is a data type.
-
valueDateTime¶ If the parameter is a data type.
-
valueTime¶ If the parameter is a data type.
-
valueCode¶ If the parameter is a data type.
-
valueOid¶ If the parameter is a data type.
-
valueUuid¶ If the parameter is a data type.
-
valueId¶ If the parameter is a data type.
-
valueUnsignedInt¶ If the parameter is a data type.
-
valuePositiveInt¶ If the parameter is a data type.
-
valueMarkdown¶ If the parameter is a data type.
-
valueElement¶ If the parameter is a data type.
-
valueExtension¶ If the parameter is a data type.
-
valueBackboneElement¶ If the parameter is a data type.
-
valueNarrative¶ If the parameter is a data type.
-
valueAnnotation¶ If the parameter is a data type.
-
valueAttachment¶ If the parameter is a data type.
-
valueIdentifier¶ If the parameter is a data type.
-
valueCodeableConcept¶ If the parameter is a data type.
-
valueCoding¶ If the parameter is a data type.
-
valueQuantity¶ If the parameter is a data type.
-
valueDuration¶ If the parameter is a data type.
-
valueSimpleQuantity¶ If the parameter is a data type.
-
valueDistance¶ If the parameter is a data type.
-
valueCount¶ If the parameter is a data type.
-
valueMoney¶ If the parameter is a data type.
-
valueAge¶ If the parameter is a data type.
-
valueRange¶ If the parameter is a data type.
-
valuePeriod¶ If the parameter is a data type.
-
valueRatio¶ If the parameter is a data type.
-
valueReference¶ If the parameter is a data type.
-
valueSampledData¶ If the parameter is a data type.
-
valueSignature¶ If the parameter is a data type.
-
valueHumanName¶ If the parameter is a data type.
-
valueAddress¶ If the parameter is a data type.
-
valueContactPoint¶ If the parameter is a data type.
-
valueTiming¶ If the parameter is a data type.
-
valueMeta¶ If the parameter is a data type.
-
valueElementDefinition¶ If the parameter is a data type.
-
valueContactDetail¶ If the parameter is a data type.
-
valueContributor¶ If the parameter is a data type.
-
valueDosage¶ If the parameter is a data type.
-
valueRelatedArtifact¶ If the parameter is a data type.
-
valueUsageContext¶ If the parameter is a data type.
-
valueDataRequirement¶ If the parameter is a data type.
-
valueParameterDefinition¶ If the parameter is a data type.
-
valueTriggerDefinition¶ If the parameter is a data type.
-
resource¶ If the parameter is a whole resource.
-
part¶ A named part of a multi-part parameter.
-
cardea.fhir.Patient module¶
-
class
cardea.fhir.Patient.Patient(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDemographics and other administrative information about an individual or animal receiving care or other health-related services.
-
resourceType¶ This is a Patient resource
-
identifier¶ An identifier for this patient.
-
active¶ Whether this patient record is in active use.
-
name¶ A name associated with the individual.
-
telecom¶ A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
-
gender¶ Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
-
birthDate¶ The date of birth for the individual.
-
deceasedBoolean¶ Indicates if the individual is deceased or not.
-
deceasedDateTime¶ Indicates if the individual is deceased or not.
-
address¶ Addresses for the individual.
-
maritalStatus¶ This field contains a patient’s most recent marital (civil) status.
-
multipleBirthBoolean¶ Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
-
multipleBirthInteger¶ Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
-
photo¶ Image of the patient.
-
contact¶ A contact party (e.g. guardian, partner, friend) for the patient.
-
animal¶ This patient is known to be an animal.
-
communication¶ Languages which may be used to communicate with the patient about his or her health.
-
generalPractitioner¶ Patient’s nominated care provider.
-
managingOrganization¶ Organization that is the custodian of the patient record.
-
link¶ Link to another patient resource that concerns the same actual patient.
-
-
class
cardea.fhir.Patient.Patient_Animal(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDemographics and other administrative information about an individual or animal receiving care or other health-related services.
-
species¶ Identifies the high level taxonomic categorization of the kind of animal.
-
breed¶ Identifies the detailed categorization of the kind of animal.
-
genderStatus¶ Indicates the current state of the animal’s reproductive organs.
-
-
class
cardea.fhir.Patient.Patient_Communication(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDemographics and other administrative information about an individual or animal receiving care or other health-related services.
-
language¶ The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. “en” for English, or “en-US” for American English versus “en-EN” for England English.
-
preferred¶ Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).
-
-
class
cardea.fhir.Patient.Patient_Contact(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDemographics and other administrative information about an individual or animal receiving care or other health-related services.
-
relationship¶ The nature of the relationship between the patient and the contact person.
-
name¶ A name associated with the contact person.
-
telecom¶ A contact detail for the person, e.g. a telephone number or an email address.
-
address¶ Address for the contact person.
-
gender¶ Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
-
organization¶ Organization on behalf of which the contact is acting or for which the contact is working.
-
period¶ The period during which this contact person or organization is valid to be contacted relating to this patient.
-
-
class
cardea.fhir.Patient.Patient_Link(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDemographics and other administrative information about an individual or animal receiving care or other health-related services.
-
other¶ The other patient resource that the link refers to.
-
type¶ The type of link between this patient resource and another patient resource.
-
cardea.fhir.PaymentNotice module¶
-
class
cardea.fhir.PaymentNotice.PaymentNotice(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the status of the payment for goods and services rendered, and the request and response resource references.
-
resourceType¶ This is a PaymentNotice resource
-
identifier¶ The notice business identifier.
-
status¶ The status of the resource instance.
-
request¶ Reference of resource for which payment is being made.
-
response¶ Reference of response to resource for which payment is being made.
-
statusDate¶ The date when the above payment action occurrred.
-
created¶ The date when this resource was created.
-
target¶ The Insurer who is target of the request.
-
provider¶ The practitioner who is responsible for the services rendered to the patient.
-
organization¶ The organization which is responsible for the services rendered to the patient.
-
paymentStatus¶ The payment status, typically paid: payment sent, cleared: payment received.
-
cardea.fhir.PaymentReconciliation module¶
-
class
cardea.fhir.PaymentReconciliation.PaymentReconciliation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides payment details and claim references supporting a bulk payment.
-
resourceType¶ This is a PaymentReconciliation resource
-
identifier¶ The Response business identifier.
-
status¶ The status of the resource instance.
-
period¶ The period of time for which payments have been gathered into this bulk payment for settlement.
-
created¶ The date when the enclosed suite of services were performed or completed.
-
organization¶ The Insurer who produced this adjudicated response.
-
request¶ Original request resource reference.
-
outcome¶ Transaction status: error, complete.
-
disposition¶ A description of the status of the adjudication.
-
requestProvider¶ The practitioner who is responsible for the services rendered to the patient.
-
requestOrganization¶ The organization which is responsible for the services rendered to the patient.
-
detail¶ List of individual settlement amounts and the corresponding transaction.
-
form¶ The form to be used for printing the content.
-
total¶ Total payment amount.
-
processNote¶ Suite of notes.
-
-
class
cardea.fhir.PaymentReconciliation.PaymentReconciliation_Detail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides payment details and claim references supporting a bulk payment.
-
type¶ Code to indicate the nature of the payment, adjustment, funds advance, etc.
-
request¶ The claim or financial resource.
-
response¶ The claim response resource.
-
submitter¶ The Organization which submitted the claim or financial transaction.
-
payee¶ The organization which is receiving the payment.
-
date¶ The date of the invoice or financial resource.
-
amount¶ Amount paid for this detail.
-
-
class
cardea.fhir.PaymentReconciliation.PaymentReconciliation_ProcessNote(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides payment details and claim references supporting a bulk payment.
-
type¶ The note purpose: Print/Display.
-
text¶ The note text.
-
cardea.fhir.Period module¶
-
class
cardea.fhir.Period.Period(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA time period defined by a start and end date and optionally time.
-
start¶ The start of the period. The boundary is inclusive.
-
end¶ The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
-
cardea.fhir.Person module¶
-
class
cardea.fhir.Person.Person(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDemographics and administrative information about a person independent of a specific health-related context.
-
resourceType¶ This is a Person resource
-
identifier¶ Identifier for a person within a particular scope.
-
name¶ A name associated with the person.
-
telecom¶ A contact detail for the person, e.g. a telephone number or an email address.
-
gender¶ Administrative Gender.
-
birthDate¶ The birth date for the person.
-
address¶ One or more addresses for the person.
-
photo¶ An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
-
managingOrganization¶ The organization that is the custodian of the person record.
-
active¶ Whether this person’s record is in active use.
-
link¶ Link to a resource that concerns the same actual person.
-
-
class
cardea.fhir.Person.Person_Link(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDemographics and administrative information about a person independent of a specific health-related context.
-
target¶ The resource to which this actual person is associated.
-
assurance¶ Level of assurance that this link is actually associated with the target resource.
-
cardea.fhir.PlanDefinition module¶
-
class
cardea.fhir.PlanDefinition.PlanDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
resourceType¶ This is a PlanDefinition resource
-
url¶ An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
-
name¶ A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the plan definition.
-
type¶ The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.
-
status¶ The status of this plan definition. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the plan definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.
-
publisher¶ The name of the individual or organization that published the plan definition.
-
description¶ A free text natural language description of the plan definition from a consumer’s perspective.
-
purpose¶ Explaination of why this plan definition is needed and why it has been designed as it has.
-
usage¶ A detailed description of how the asset is used from a clinical perspective.
-
approvalDate¶ The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate¶ The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn’t change the original approval date.
-
effectivePeriod¶ The period during which the plan definition content was or is planned to be in active use.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate plan definition instances.
-
jurisdiction¶ A legal or geographic region in which the plan definition is intended to be used.
-
topic¶ Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.
-
contributor¶ A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
copyright¶ A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.
Related artifacts such as additional documentation, justification, or bibliographic references.
-
library¶ A reference to a Library resource containing any formal logic used by the plan definition.
-
goal¶ Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
-
action¶ An action to be taken as part of the plan.
-
-
class
cardea.fhir.PlanDefinition.PlanDefinition_Action(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
label¶ A user-visible label for the action.
-
title¶ The title of the action displayed to a user.
-
description¶ A short description of the action used to provide a summary to display to the user.
-
textEquivalent¶ A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that may not be capable of interpreting it dynamically.
-
code¶ A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a the section of a documentation template.
-
reason¶ A description of why this action is necessary or appropriate.
-
documentation¶ Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.
-
goalId¶ Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
-
triggerDefinition¶ A description of when the action should be triggered.
-
condition¶ An expression that describes applicability criteria, or start/stop conditions for the action.
-
input¶ Defines input data requirements for the action.
-
output¶ Defines the outputs of the action, if any.
A relationship to another action such as “before” or “30-60 minutes after start of”.
-
timingDateTime¶ An optional value describing when the action should be performed.
-
timingPeriod¶ An optional value describing when the action should be performed.
-
timingDuration¶ An optional value describing when the action should be performed.
-
timingRange¶ An optional value describing when the action should be performed.
-
timingTiming¶ An optional value describing when the action should be performed.
-
participant¶ Indicates who should participate in performing the action described.
-
type¶ The type of action to perform (create, update, remove).
-
groupingBehavior¶ Defines the grouping behavior for the action and its children.
-
selectionBehavior¶ Defines the selection behavior for the action and its children.
-
requiredBehavior¶ Defines the requiredness behavior for the action.
-
precheckBehavior¶ Defines whether the action should usually be preselected.
-
cardinalityBehavior¶ Defines whether the action can be selected multiple times.
-
definition¶ A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
-
transform¶ A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
-
dynamicValue¶ Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient’s weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.
-
action¶ Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.
-
-
class
cardea.fhir.PlanDefinition.PlanDefinition_Condition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
kind¶ The kind of condition.
-
description¶ A brief, natural language description of the condition that effectively communicates the intended semantics.
-
language¶ The media type of the language for the expression.
-
expression¶ An expression that returns true or false, indicating whether or not the condition is satisfied.
-
-
class
cardea.fhir.PlanDefinition.PlanDefinition_DynamicValue(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
description¶ A brief, natural language description of the intended semantics of the dynamic value.
-
path¶ The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression.
-
language¶ The media type of the language for the expression.
-
expression¶ An expression specifying the value of the customized element.
-
-
class
cardea.fhir.PlanDefinition.PlanDefinition_Goal(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
category¶ Indicates a category the goal falls within.
-
description¶ Human-readable and/or coded description of a specific desired objective of care, such as “control blood pressure” or “negotiate an obstacle course” or “dance with child at wedding”.
-
priority¶ Identifies the expected level of importance associated with reaching/sustaining the defined goal.
-
start¶ The event after which the goal should begin being pursued.
-
addresses¶ Identifies problems, conditions, issues, or concerns the goal is intended to address.
-
documentation¶ Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.
-
target¶ Indicates what should be done and within what timeframe.
-
-
class
cardea.fhir.PlanDefinition.PlanDefinition_Participant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
type¶ The type of participant in the action.
-
role¶ The role the participant should play in performing the described action.
-
-
class
cardea.fhir.PlanDefinition.PlanDefinition_RelatedAction(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
actionId¶ The element id of the related action.
-
relationship¶ The relationship of this action to the related action.
-
offsetDuration¶ A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
-
offsetRange¶ A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
-
-
class
cardea.fhir.PlanDefinition.PlanDefinition_Target(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
measure¶ The parameter whose value is to be tracked, e.g. body weigth, blood pressure, or hemoglobin A1c level.
-
detailQuantity¶ The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. Whan a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.
-
detailRange¶ The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. Whan a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.
-
detailCodeableConcept¶ The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. Whan a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.
-
due¶ Indicates the timeframe after the start of the goal in which the goal should be met.
-
cardea.fhir.Practitioner module¶
-
class
cardea.fhir.Practitioner.Practitioner(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA person who is directly or indirectly involved in the provisioning of healthcare.
-
resourceType¶ This is a Practitioner resource
-
identifier¶ An identifier that applies to this person in this role.
-
active¶ Whether this practitioner’s record is in active use.
-
name¶ The name(s) associated with the practitioner.
-
telecom¶ A contact detail for the practitioner, e.g. a telephone number or an email address.
-
address¶ Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.
-
gender¶ Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
-
birthDate¶ The date of birth for the practitioner.
-
photo¶ Image of the person.
-
qualification¶ Qualifications obtained by training and certification.
-
communication¶ A language the practitioner is able to use in patient communication.
-
-
class
cardea.fhir.Practitioner.Practitioner_Qualification(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA person who is directly or indirectly involved in the provisioning of healthcare.
-
identifier¶ An identifier that applies to this person’s qualification in this role.
-
code¶ Coded representation of the qualification.
-
period¶ Period during which the qualification is valid.
-
issuer¶ Organization that regulates and issues the qualification.
-
cardea.fhir.PractitionerRole module¶
-
class
cardea.fhir.PractitionerRole.PractitionerRole(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
-
resourceType¶ This is a PractitionerRole resource
-
identifier¶ Business Identifiers that are specific to a role/location.
-
active¶ Whether this practitioner’s record is in active use.
-
period¶ The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
-
practitioner¶ Practitioner that is able to provide the defined services for the organation.
-
organization¶ The organization where the Practitioner performs the roles associated.
-
code¶ Roles which this practitioner is authorized to perform for the organization.
-
specialty¶ Specific specialty of the practitioner.
-
location¶ The location(s) at which this practitioner provides care.
-
healthcareService¶ The list of healthcare services that this worker provides for this role’s Organization/Location(s).
-
telecom¶ Contact details that are specific to the role/location/service.
-
availableTime¶ A collection of times that the Service Site is available.
-
notAvailable¶ The HealthcareService is not available during this period of time due to the provided reason.
-
availabilityExceptions¶ A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
-
endpoint¶ Technical endpoints providing access to services operated for the practitioner with this role.
-
-
class
cardea.fhir.PractitionerRole.PractitionerRole_AvailableTime(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
-
daysOfWeek¶ Indicates which days of the week are available between the start and end Times.
-
allDay¶ Is this always available? (hence times are irrelevant) e.g. 24 hour service.
-
availableStartTime¶ The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
-
availableEndTime¶ The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
-
-
class
cardea.fhir.PractitionerRole.PractitionerRole_NotAvailable(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
-
description¶ The reason that can be presented to the user as to why this time is not available.
-
during¶ Service is not available (seasonally or for a public holiday) from this date.
-
cardea.fhir.Procedure module¶
-
class
cardea.fhir.Procedure.Procedure(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.
-
resourceType¶ This is a Procedure resource
-
identifier¶ This records identifiers associated with this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
definition¶ A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure.
-
basedOn¶ A reference to a resource that contains details of the request for this procedure.
-
partOf¶ A larger event of which this particular procedure is a component or step.
-
status¶ A code specifying the state of the procedure. Generally this will be in-progress or completed state.
-
notDone¶ Set this to true if the record is saying that the procedure was NOT performed.
-
notDoneReason¶ A code indicating why the procedure was not performed.
-
category¶ A code that classifies the procedure for searching, sorting and display purposes (e.g. “Surgical Procedure”).
-
code¶ The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. “Laparoscopic Appendectomy”).
-
subject¶ The person, animal or group on which the procedure was performed.
-
context¶ The encounter during which the procedure was performed.
-
performedDateTime¶ The date(time)/period over which the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
-
performedPeriod¶ The date(time)/period over which the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
-
performer¶ Limited to ‘real’ people rather than equipment.
-
location¶ The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
-
reasonCode¶ The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text.
-
reasonReference¶ The condition that is the reason why the procedure was performed.
-
bodySite¶ Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
-
outcome¶ The outcome of the procedure - did it resolve reasons for the procedure being performed?
-
report¶ This could be a histology result, pathology report, surgical report, etc..
-
complication¶ Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any ‘post procedure’ issues.
-
complicationDetail¶ Any complications that occurred during the procedure, or in the immediate post-performance period.
-
followUp¶ If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or could potentially be more complex in which case the CarePlan resource can be used.
-
note¶ Any other notes about the procedure. E.g. the operative notes.
-
focalDevice¶ A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.
-
usedReference¶ Identifies medications, devices and any other substance used as part of the procedure.
-
usedCode¶ Identifies coded items that were used as part of the procedure.
-
-
class
cardea.fhir.Procedure.Procedure_FocalDevice(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.
-
action¶ The kind of change that happened to the device during the procedure.
-
manipulated¶ The device that was manipulated (changed) during the procedure.
-
-
class
cardea.fhir.Procedure.Procedure_Performer(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.
-
role¶ For example: surgeon, anaethetist, endoscopist.
-
actor¶ The practitioner who was involved in the procedure.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
cardea.fhir.ProcedureRequest module¶
-
class
cardea.fhir.ProcedureRequest.ProcedureRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a request for diagnostic investigations, treatments, or operations to be performed.
-
resourceType¶ This is a ProcedureRequest resource
-
identifier¶ Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
-
definition¶ Protocol or definition followed by this request.
-
basedOn¶ Plan/proposal/order fulfilled by this request.
-
replaces¶ The request takes the place of the referenced completed or terminated request(s).
-
requisition¶ A shared identifier common to all procedure or diagnostic requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
-
status¶ The status of the order.
-
intent¶ Whether the request is a proposal, plan, an original order or a reflex order.
-
priority¶ Indicates how quickly the ProcedureRequest should be addressed with respect to other requests.
-
doNotPerform¶ Set this to true if the record is saying that the procedure should NOT be performed.
-
category¶ A code that classifies the procedure for searching, sorting and display purposes (e.g. “Surgical Procedure”).
-
code¶ A code that identifies a particular procedure, diagnostic investigation, or panel of investigations, that have been requested.
-
subject¶ On whom or what the procedure or diagnostic is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
-
context¶ An encounter or episode of care that provides additional information about the healthcare context in which this request is made.
-
occurrenceDateTime¶ The date/time at which the diagnostic testing should occur.
-
occurrencePeriod¶ The date/time at which the diagnostic testing should occur.
-
occurrenceTiming¶ The date/time at which the diagnostic testing should occur.
-
asNeededBoolean¶ If a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example “pain”, “on flare-up”, etc.
-
asNeededCodeableConcept¶ If a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example “pain”, “on flare-up”, etc.
When the request transitioned to being actionable.
-
requester¶ The individual who initiated the request and has responsibility for its activation.
-
performerType¶ Desired type of performer for doing the diagnostic testing.
-
performer¶ The desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc.
-
reasonCode¶ An explanation or justification for why this diagnostic investigation is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInformation.
-
reasonReference¶ Indicates another resource that provides a justification for why this diagnostic investigation is being requested. May relate to the resources referred to in supportingInformation.
-
supportingInfo¶ Additional clinical information about the patient or specimen that may influence the procedure or diagnostics or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as “ask at order entry questions (AOEs)”. This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
-
specimen¶ One or more specimens that the laboratory procedure will use.
-
bodySite¶ Anatomic location where the procedure should be performed. This is the target site.
-
note¶ Any other notes and comments made about the service request. For example, letting provider know that “patient hates needles” or other provider instructions.
-
relevantHistory¶ Key events in the history of the request.
-
-
class
cardea.fhir.ProcedureRequest.ProcedureRequest_Requester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a request for diagnostic investigations, treatments, or operations to be performed.
-
agent¶ The device, practitioner or organization who initiated the request.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
cardea.fhir.ProcessRequest module¶
-
class
cardea.fhir.ProcessRequest.ProcessRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the target, request and response, and action details for an action to be performed by the target on or about existing resources.
-
resourceType¶ This is a ProcessRequest resource
-
identifier¶ The ProcessRequest business identifier.
-
status¶ The status of the resource instance.
-
action¶ The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest.
-
target¶ The organization which is the target of the request.
-
created¶ The date when this resource was created.
-
provider¶ The practitioner who is responsible for the action specified in this request.
-
organization¶ The organization which is responsible for the action speccified in this request.
-
request¶ Reference of resource which is the target or subject of this action.
-
response¶ Reference of a prior response to resource which is the target or subject of this action.
-
nullify¶ If true remove all history excluding audit.
-
reference¶ A reference to supply which authenticates the process.
-
item¶ List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
-
include¶ Names of resource types to include.
-
exclude¶ Names of resource types to exclude.
-
period¶ A period of time during which the fulfilling resources would have been created.
-
-
class
cardea.fhir.ProcessRequest.ProcessRequest_Item(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the target, request and response, and action details for an action to be performed by the target on or about existing resources.
-
sequenceLinkId¶ A service line number.
-
cardea.fhir.ProcessResponse module¶
-
class
cardea.fhir.ProcessResponse.ProcessResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides processing status, errors and notes from the processing of a resource.
-
resourceType¶ This is a ProcessResponse resource
-
identifier¶ The Response business identifier.
-
status¶ The status of the resource instance.
-
created¶ The date when the enclosed suite of services were performed or completed.
-
organization¶ The organization who produced this adjudicated response.
-
request¶ Original request resource reference.
-
outcome¶ Transaction status: error, complete, held.
-
disposition¶ A description of the status of the adjudication or processing.
-
requestProvider¶ The practitioner who is responsible for the services rendered to the patient.
-
requestOrganization¶ The organization which is responsible for the services rendered to the patient.
-
form¶ The form to be used for printing the content.
-
processNote¶ Suite of processing notes or additional requirements if the processing has been held.
-
error¶ Processing errors.
-
communicationRequest¶ Request for additional supporting or authorizing information, such as: documents, images or resources.
-
-
class
cardea.fhir.ProcessResponse.ProcessResponse_ProcessNote(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides processing status, errors and notes from the processing of a resource.
-
type¶ The note purpose: Print/Display.
-
text¶ The note text.
-
cardea.fhir.Provenance module¶
-
class
cardea.fhir.Provenance.Provenance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseProvenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.
-
resourceType¶ This is a Provenance resource
-
target¶ The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.
-
period¶ The period during which the activity occurred.
-
recorded¶ The instant of time at which the activity was recorded.
-
policy¶ Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
-
location¶ Where the activity occurred, if relevant.
-
reason¶ The reason that the activity was taking place.
-
activity¶ An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
-
agent¶ An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
-
entity¶ An entity used in this activity.
-
signature¶ A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
-
-
class
cardea.fhir.Provenance.Provenance_Agent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseProvenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.
-
role¶ The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.
-
whoUri¶ The individual, device or organization that participated in the event.
-
whoReference¶ The individual, device or organization that participated in the event.
-
onBehalfOfUri¶ The individual, device, or organization for whom the change was made.
-
onBehalfOfReference¶ The individual, device, or organization for whom the change was made.
The type of relationship between agents.
-
-
class
cardea.fhir.Provenance.Provenance_Entity(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseProvenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.
-
role¶ How the entity was used during the activity.
-
whatUri¶ Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.
-
whatReference¶ Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.
-
whatIdentifier¶ Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.
-
agent¶ The entity is attributed to an agent to express the agent’s responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.
-
cardea.fhir.Quantity module¶
-
class
cardea.fhir.Quantity.Quantity(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
value¶ The value of the measured amount. The value includes an implicit precision in the presentation of the value.
-
comparator¶ How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is “<” , then the real value is < stated value.
-
unit¶ A human-readable form of the unit.
-
system¶ The identification of the system that provides the coded form of the unit.
-
code¶ A computer processable form of the unit in some unit representation system.
-
cardea.fhir.Questionnaire module¶
-
class
cardea.fhir.Questionnaire.Questionnaire(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
-
resourceType¶ This is a Questionnaire resource
-
url¶ An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this questionnaire is (or will be) published. The URL SHOULD include the major version of the questionnaire. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the questionnaire.
-
status¶ The status of this questionnaire. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the questionnaire was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.
-
publisher¶ The name of the individual or organization that published the questionnaire.
-
description¶ A free text natural language description of the questionnaire from a consumer’s perspective.
-
purpose¶ Explaination of why this questionnaire is needed and why it has been designed as it has.
-
approvalDate¶ The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate¶ The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn’t change the original approval date.
-
effectivePeriod¶ The period during which the questionnaire content was or is planned to be in active use.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate questionnaire instances.
-
jurisdiction¶ A legal or geographic region in which the questionnaire is intended to be used.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
copyright¶ A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.
-
code¶ An identifier for this question or group of questions in a particular terminology such as LOINC.
-
subjectType¶ The types of subjects that can be the subject of responses created for the questionnaire.
-
item¶ A particular question, question grouping or display text that is part of the questionnaire.
-
-
class
cardea.fhir.Questionnaire.Questionnaire_EnableWhen(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
-
question¶ The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.
-
hasAnswer¶ An indication that this item should be enabled only if the specified question is answered (hasAnswer=true) or not answered (hasAnswer=false).
-
answerBoolean¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerDecimal¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerInteger¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerDate¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerDateTime¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerTime¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerString¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerUri¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerAttachment¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerCoding¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerQuantity¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerReference¶ An answer that the referenced question must match in order for the item to be enabled.
-
-
class
cardea.fhir.Questionnaire.Questionnaire_Item(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
-
linkId¶ An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.
-
definition¶ A reference to an [[[ElementDefinition]]] that provides the details for the item. If a definition is provided, then the following element values can be inferred from the definition: * code (ElementDefinition.code) * type (ElementDefinition.type) * required (ElementDefinition.min) * repeats (ElementDefinition.max) * maxLength (ElementDefinition.maxLength) * options (ElementDefinition.binding) Any information provided in these elements on a Questionnaire Item overrides the information from the definition.
-
code¶ A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).
-
prefix¶ A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.
-
text¶ The name of a section, the text of a question or text content for a display item.
-
type¶ The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).
-
enableWhen¶ A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.
-
required¶ An indication, if true, that the item must be present in a “completed” QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.
-
repeats¶ An indication, if true, that the item may occur multiple times in the response, collecting multiple answers answers for questions or multiple sets of answers for groups.
-
readOnly¶ An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.
-
maxLength¶ The maximum number of characters that are permitted in the answer to be considered a “valid” QuestionnaireResponse.
-
options¶ A reference to a value set containing a list of codes representing permitted answers for a “choice” or “open-choice” question.
-
option¶ One of the permitted answers for a “choice” or “open-choice” question.
-
initialBoolean¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialDecimal¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialInteger¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialDate¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialDateTime¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialTime¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialString¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialUri¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialAttachment¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialCoding¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialQuantity¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialReference¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
item¶ Text, questions and other groups to be nested beneath a question or group.
-
-
class
cardea.fhir.Questionnaire.Questionnaire_Option(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
-
valueInteger¶ A potential answer that’s allowed as the answer to this question.
-
valueDate¶ A potential answer that’s allowed as the answer to this question.
-
valueTime¶ A potential answer that’s allowed as the answer to this question.
-
valueString¶ A potential answer that’s allowed as the answer to this question.
-
valueCoding¶ A potential answer that’s allowed as the answer to this question.
-
cardea.fhir.QuestionnaireResponse module¶
-
class
cardea.fhir.QuestionnaireResponse.QuestionnaireResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
-
resourceType¶ This is a QuestionnaireResponse resource
-
identifier¶ A business identifier assigned to a particular completed (or partially completed) questionnaire.
-
basedOn¶ The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ProcedureRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.
-
parent¶ A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.
-
questionnaire¶ The Questionnaire that defines and organizes the questions for which answers are being provided.
-
status¶ The position of the questionnaire response within its overall lifecycle.
-
subject¶ The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.
-
context¶ The encounter or episode of care with primary association to the questionnaire response.
The date and/or time that this set of answers were last changed.
Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
-
source¶ The person who answered the questions about the subject.
-
item¶ A group or question item from the original questionnaire for which answers are provided.
-
-
class
cardea.fhir.QuestionnaireResponse.QuestionnaireResponse_Answer(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
-
valueBoolean¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueDecimal¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueInteger¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueDate¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueDateTime¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueTime¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueString¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueUri¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueAttachment¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueCoding¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueQuantity¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueReference¶ The answer (or one of the answers) provided by the respondent to the question.
-
item¶ Nested groups and/or questions found within this particular answer.
-
-
class
cardea.fhir.QuestionnaireResponse.QuestionnaireResponse_Item(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
-
linkId¶ The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.
-
definition¶ A reference to an [[[ElementDefinition]]] that provides the details for the item.
-
text¶ Text that is displayed above the contents of the group or as the text of the question being answered.
-
subject¶ More specific subject this section’s answers are about, details the subject given in QuestionnaireResponse.
-
answer¶ The respondent’s answer(s) to the question.
-
item¶ Questions or sub-groups nested beneath a question or group.
-
cardea.fhir.Range module¶
-
class
cardea.fhir.Range.Range(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of ordered Quantities defined by a low and high limit.
-
low¶ The low limit. The boundary is inclusive.
-
high¶ The high limit. The boundary is inclusive.
-
cardea.fhir.Ratio module¶
-
class
cardea.fhir.Ratio.Ratio(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA relationship of two Quantity values - expressed as a numerator and a denominator.
-
numerator¶ The value of the numerator.
-
denominator¶ The value of the denominator.
-
cardea.fhir.Reference module¶
-
class
cardea.fhir.Reference.Reference(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reference from one resource to another.
-
reference¶ A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with ‘#’) refer to contained resources.
-
identifier¶ An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
-
display¶ Plain text narrative that identifies the resource in addition to the resource reference.
-
cardea.fhir.ReferralRequest module¶
-
class
cardea.fhir.ReferralRequest.ReferralRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseUsed to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.
-
resourceType¶ This is a ReferralRequest resource
-
identifier¶ Business identifier that uniquely identifies the referral/care transfer request instance.
-
definition¶ A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
-
basedOn¶ Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.
-
replaces¶ Completed or terminated request(s) whose function is taken by this new request.
-
groupIdentifier¶ The business identifier of the logical “grouping” request/order that this referral is a part of.
-
status¶ The status of the authorization/intention reflected by the referral request record.
-
intent¶ Distinguishes the “level” of authorization/demand implicit in this request.
-
type¶ An indication of the type of referral (or where applicable the type of transfer of care) request.
-
priority¶ An indication of the urgency of referral (or where applicable the type of transfer of care) request.
-
serviceRequested¶ The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.
-
subject¶ The patient who is the subject of a referral or transfer of care request.
-
context¶ The encounter at which the request for referral or transfer of care is initiated.
-
occurrenceDateTime¶ The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
-
occurrencePeriod¶ The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
Date/DateTime of creation for draft requests and date of activation for active requests.
-
requester¶ The individual who initiated the request and has responsibility for its activation.
-
specialty¶ Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.
-
recipient¶ The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.
-
reasonCode¶ Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.
-
reasonReference¶ Indicates another resource whose existence justifies this request.
-
description¶ The reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.
-
supportingInfo¶ Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan.
-
note¶ Comments made about the referral request by any of the participants.
-
relevantHistory¶ Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.
-
-
class
cardea.fhir.ReferralRequest.ReferralRequest_Requester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseUsed to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.
-
agent¶ The device, practitioner, etc. who initiated the request.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
cardea.fhir.RelatedArtifact module¶
-
class
cardea.fhir.RelatedArtifact.RelatedArtifact(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRelated artifacts such as additional documentation, justification, or bibliographic references.
-
type¶ The type of relationship to the related artifact.
-
display¶ A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
-
citation¶ A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
-
url¶ A url for the artifact that can be followed to access the actual content.
-
document¶ The document being referenced, represented as an attachment. This is exclusive with the resource element.
-
resource¶ The related resource, such as a library, value set, profile, or other knowledge resource.
-
cardea.fhir.RelatedPerson module¶
-
class
cardea.fhir.RelatedPerson.RelatedPerson(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseInformation about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
-
resourceType¶ This is a RelatedPerson resource
-
identifier¶ Identifier for a person within a particular scope.
-
active¶ Whether this related person record is in active use.
-
patient¶ The patient this person is related to.
-
relationship¶ The nature of the relationship between a patient and the related person.
-
name¶ A name associated with the person.
-
telecom¶ A contact detail for the person, e.g. a telephone number or an email address.
-
gender¶ Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
-
birthDate¶ The date on which the related person was born.
-
address¶ Address where the related person can be contacted or visited.
-
photo¶ Image of the person.
-
period¶ The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.
-
cardea.fhir.RequestGroup module¶
-
class
cardea.fhir.RequestGroup.RequestGroup(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA group of related requests that can be used to capture intended activities that have inter-dependencies such as “give this medication after that one”.
-
resourceType¶ This is a RequestGroup resource
-
identifier¶ Allows a service to provide a unique, business identifier for the request.
-
definition¶ A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
-
basedOn¶ A plan, proposal or order that is fulfilled in whole or in part by this request.
-
replaces¶ Completed or terminated request(s) whose function is taken by this new request.
-
groupIdentifier¶ A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
-
status¶ The current state of the request. For request groups, the status reflects the status of all the requests in the group.
-
intent¶ Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
-
priority¶ Indicates how quickly the request should be addressed with respect to other requests.
-
subject¶ The subject for which the request group was created.
-
context¶ Describes the context of the request group, if any.
Indicates when the request group was created.
Provides a reference to the author of the request group.
-
reasonCodeableConcept¶ Indicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
-
reasonReference¶ Indicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
-
note¶ Provides a mechanism to communicate additional information about the response.
-
action¶ The actions, if any, produced by the evaluation of the artifact.
-
-
class
cardea.fhir.RequestGroup.RequestGroup_Action(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA group of related requests that can be used to capture intended activities that have inter-dependencies such as “give this medication after that one”.
-
label¶ A user-visible label for the action.
-
title¶ The title of the action displayed to a user.
-
description¶ A short description of the action used to provide a summary to display to the user.
-
textEquivalent¶ A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that may not be capable of interpreting it dynamically.
-
code¶ A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a the section of a documentation template.
-
documentation¶ Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.
-
condition¶ An expression that describes applicability criteria, or start/stop conditions for the action.
A relationship to another action such as “before” or “30-60 minutes after start of”.
-
timingDateTime¶ An optional value describing when the action should be performed.
-
timingPeriod¶ An optional value describing when the action should be performed.
-
timingDuration¶ An optional value describing when the action should be performed.
-
timingRange¶ An optional value describing when the action should be performed.
-
timingTiming¶ An optional value describing when the action should be performed.
-
participant¶ The participant that should perform or be responsible for this action.
-
type¶ The type of action to perform (create, update, remove).
-
groupingBehavior¶ Defines the grouping behavior for the action and its children.
-
selectionBehavior¶ Defines the selection behavior for the action and its children.
-
requiredBehavior¶ Defines the requiredness behavior for the action.
-
precheckBehavior¶ Defines whether the action should usually be preselected.
-
cardinalityBehavior¶ Defines whether the action can be selected multiple times.
-
resource¶ The resource that is the target of the action (e.g. CommunicationRequest).
-
action¶ Sub actions.
-
-
class
cardea.fhir.RequestGroup.RequestGroup_Condition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA group of related requests that can be used to capture intended activities that have inter-dependencies such as “give this medication after that one”.
-
kind¶ The kind of condition.
-
description¶ A brief, natural language description of the condition that effectively communicates the intended semantics.
-
language¶ The media type of the language for the expression.
-
expression¶ An expression that returns true or false, indicating whether or not the condition is satisfied.
-
-
class
cardea.fhir.RequestGroup.RequestGroup_RelatedAction(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA group of related requests that can be used to capture intended activities that have inter-dependencies such as “give this medication after that one”.
-
actionId¶ The element id of the action this is related to.
-
relationship¶ The relationship of this action to the related action.
-
offsetDuration¶ A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
-
offsetRange¶ A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
-
cardea.fhir.ResearchStudy module¶
-
class
cardea.fhir.ResearchStudy.ResearchStudy(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.
-
resourceType¶ This is a ResearchStudy resource
-
identifier¶ Identifiers assigned to this research study by the sponsor or other systems.
-
title¶ A short, descriptive user-friendly label for the study.
-
protocol¶ The set of steps expected to be performed as part of the execution of the study.
-
partOf¶ A larger research study of which this particular study is a component or step.
-
status¶ The current state of the study.
-
category¶ Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
-
focus¶ The condition(s), medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
-
contact¶ Contact details to assist a user in learning more about or engaging with the study.
Citations, references and other related documents.
-
keyword¶ Key terms to aid in searching for or filtering the study.
-
jurisdiction¶ Indicates a country, state or other region where the study is taking place.
-
description¶ A full description of how the study is being conducted.
-
enrollment¶ Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. ” 200 female Europeans between the ages of 20 and 45 with early onset diabetes”.
-
period¶ Identifies the start date and the expected (or actual, depending on status) end date for the study.
-
sponsor¶ The organization responsible for the execution of the study.
-
principalInvestigator¶ Indicates the individual who has primary oversite of the execution of the study.
-
site¶ Clinic, hospital or other healthcare location that is participating in the study.
-
reasonStopped¶ A description and/or code explaining the premature termination of the study.
-
note¶ Comments made about the event by the performer, subject or other participants.
-
arm¶ Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.
-
-
class
cardea.fhir.ResearchStudy.ResearchStudy_Arm(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.
-
name¶ Unique, human-readable label for this arm of the study.
-
code¶ Categorization of study arm, e.g. experimental, active comparator, placebo comparater.
-
description¶ A succinct description of the path through the study that would be followed by a subject adhering to this arm.
-
cardea.fhir.ResearchSubject module¶
-
class
cardea.fhir.ResearchSubject.ResearchSubject(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.
-
resourceType¶ This is a ResearchSubject resource
-
identifier¶ Identifiers assigned to this research study by the sponsor or other systems.
-
status¶ The current state of the subject.
-
period¶ The dates the subject began and ended their participation in the study.
-
study¶ Reference to the study the subject is participating in.
-
individual¶ The record of the person or animal who is involved in the study.
-
assignedArm¶ The name of the arm in the study the subject is expected to follow as part of this study.
-
actualArm¶ The name of the arm in the study the subject actually followed as part of this study.
-
consent¶ A record of the patient’s informed agreement to participate in the study.
-
cardea.fhir.Resource module¶
-
class
cardea.fhir.Resource.Resource(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis is the base resource type for everything.
-
id¶ The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
-
meta¶ The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
-
implicitRules¶ A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
-
language¶ The base language in which the resource is written.
-
cardea.fhir.ResourceList module¶
cardea.fhir.RiskAssessment module¶
-
class
cardea.fhir.RiskAssessment.RiskAssessment(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.
-
resourceType¶ This is a RiskAssessment resource
-
identifier¶ Business identifier assigned to the risk assessment.
-
basedOn¶ A reference to the request that is fulfilled by this risk assessment.
-
parent¶ A reference to a resource that this risk assessment is part of, such as a Procedure.
-
status¶ The status of the RiskAssessment, using the same statuses as an Observation.
-
method¶ The algorithm, process or mechanism used to evaluate the risk.
-
code¶ The type of the risk assessment performed.
-
subject¶ The patient or group the risk assessment applies to.
-
context¶ The encounter where the assessment was performed.
-
occurrenceDateTime¶ The date (and possibly time) the risk assessment was performed.
-
occurrencePeriod¶ The date (and possibly time) the risk assessment was performed.
-
condition¶ For assessments or prognosis specific to a particular condition, indicates the condition being assessed.
-
performer¶ The provider or software application that performed the assessment.
-
reasonCodeableConcept¶ The reason the risk assessment was performed.
-
reasonReference¶ The reason the risk assessment was performed.
-
basis¶ Indicates the source data considered as part of the assessment (FamilyHistory, Observations, Procedures, Conditions, etc.).
-
prediction¶ Describes the expected outcome for the subject.
-
mitigation¶ A description of the steps that might be taken to reduce the identified risk(s).
-
comment¶ Additional comments about the risk assessment.
-
-
class
cardea.fhir.RiskAssessment.RiskAssessment_Prediction(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.
-
outcome¶ One of the potential outcomes for the patient (e.g. remission, death, a particular condition).
-
probabilityDecimal¶ How likely is the outcome (in the specified timeframe).
-
probabilityRange¶ How likely is the outcome (in the specified timeframe).
-
qualitativeRisk¶ How likely is the outcome (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, high).
-
relativeRisk¶ Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk.).
-
whenPeriod¶ Indicates the period of time or age range of the subject to which the specified probability applies.
-
whenRange¶ Indicates the period of time or age range of the subject to which the specified probability applies.
-
rationale¶ Additional information explaining the basis for the prediction.
-
cardea.fhir.SampledData module¶
-
class
cardea.fhir.SampledData.SampledData(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
-
origin¶ The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.
-
period¶ The length of time between sampling times, measured in milliseconds.
-
factor¶ A correction factor that is applied to the sampled data points before they are added to the origin.
-
lowerLimit¶ The lower limit of detection of the measured points. This is needed if any of the data points have the value “L” (lower than detection limit).
-
upperLimit¶ The upper limit of detection of the measured points. This is needed if any of the data points have the value “U” (higher than detection limit).
-
dimensions¶ The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.
-
data¶ A series of data points which are decimal values separated by a single space (character u20). The special values “E” (error), “L” (below detection limit) and “U” (above detection limit) can also be used in place of a decimal value.
-
cardea.fhir.Schedule module¶
-
class
cardea.fhir.Schedule.Schedule(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA container for slots of time that may be available for booking appointments.
-
resourceType¶ This is a Schedule resource
-
identifier¶ External Ids for this item.
-
active¶ Whether this schedule record is in active use, or should not be used (such as was entered in error).
-
serviceCategory¶ A broad categorisation of the service that is to be performed during this appointment.
-
serviceType¶ The specific service that is to be performed during this appointment.
-
specialty¶ The specialty of a practitioner that would be required to perform the service requested in this appointment.
-
actor¶ The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson.
-
planningHorizon¶ The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization’s planning horizon; the interval for which they are currently accepting appointments. This does not define a “template” for planning outside these dates.
-
comment¶ Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.
-
cardea.fhir.SearchParameter module¶
-
class
cardea.fhir.SearchParameter.SearchParameter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA search parameter that defines a named search item that can be used to search/filter on a resource.
-
resourceType¶ This is a SearchParameter resource
-
url¶ An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see [Technical and Business Versions](resource.html#versions).
-
version¶ The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
status¶ The status of this search parameter. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the search parameter was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.
-
publisher¶ The name of the individual or organization that published the search parameter.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate search parameter instances.
-
jurisdiction¶ A legal or geographic region in which the search parameter is intended to be used.
-
purpose¶ Explaination of why this search parameter is needed and why it has been designed as it has.
-
code¶ The code used in the URL or the parameter name in a parameters resource for this search parameter.
-
base¶ The base resource type(s) that this search parameter can be used against.
-
type¶ The type of value a search parameter refers to, and how the content is interpreted.
-
derivedFrom¶ Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. I.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.
-
description¶ A free text natural language description of the search parameter from a consumer’s perspective. and how it used.
-
expression¶ A FHIRPath expression that returns a set of elements for the search parameter.
-
xpath¶ An XPath expression that returns a set of elements for the search parameter.
-
xpathUsage¶ How the search parameter relates to the set of elements returned by evaluating the xpath query.
-
target¶ Types of resource (if a resource is referenced).
-
comparator¶ Comparators supported for the search parameter.
-
modifier¶ A modifier supported for the search parameter.
-
chain¶ Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference, and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.
-
component¶ Used to define the parts of a composite search parameter.
-
-
class
cardea.fhir.SearchParameter.SearchParameter_Component(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA search parameter that defines a named search item that can be used to search/filter on a resource.
-
definition¶ The definition of the search parameter that describes this part.
-
expression¶ A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.
-
cardea.fhir.Sequence module¶
-
class
cardea.fhir.Sequence.Sequence(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRaw data describing a biological sequence.
-
resourceType¶ This is a Sequence resource
-
identifier¶ A unique identifier for this particular sequence instance. This is a FHIR-defined id.
-
type¶ Amino Acid Sequence/ DNA Sequence / RNA Sequence.
-
coordinateSystem¶ Whether the sequence is numbered starting at 0 (0-based numbering or coordinates, inclusive start, exclusive end) or starting at 1 (1-based numbering, inclusive start and inclusive end).
-
patient¶ The patient whose sequencing results are described by this resource.
-
specimen¶ Specimen used for sequencing.
-
device¶ The method for sequencing, for example, chip information.
-
performer¶ The organization or lab that should be responsible for this result.
-
quantity¶ The number of copies of the seqeunce of interest. (RNASeq).
-
referenceSeq¶ A sequence that is used as a reference to describe variants that are present in a sequence analyzed.
-
variant¶ The definition of variant here originates from Sequence ontology ([variant_of](http://www.sequenceontology.org/browser/current_svn/term/variant_of)). This element can represent amino acid or nucleic sequence change(including insertion,deletion,SNP,etc.) It can represent some complex mutation or segment variation with the assist of CIGAR string.
-
observedSeq¶ Sequence that was observed. It is the result marked by referenceSeq along with variant records on referenceSeq. This shall starts from referenceSeq.windowStart and end by referenceSeq.windowEnd.
-
quality¶ An experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score ([SO:0001686](http://www.sequenceontology.org/browser/current_svn/term/SO:0001686)).
-
readCoverage¶ Coverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence.
-
repository¶ Configurations of the external repository. The repository shall store target’s observedSeq or records related with target’s observedSeq.
-
pointer¶ Pointer to next atomic sequence which at most contains one variant.
-
-
class
cardea.fhir.Sequence.Sequence_Quality(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRaw data describing a biological sequence.
-
type¶ INDEL / SNP / Undefined variant.
-
standardSequence¶ Gold standard sequence used for comparing against.
-
start¶ Start position of the sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.
-
end¶ End position of the sequence.If the coordinate system is 0-based then end is is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.
-
score¶ The score of an experimentally derived feature such as a p-value ([SO:0001685](http://www.sequenceontology.org/browser/current_svn/term/SO:0001685)).
-
method¶ Which method is used to get sequence quality.
-
truthTP¶ True positives, from the perspective of the truth data, i.e. the number of sites in the Truth Call Set for which there are paths through the Query Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.
-
queryTP¶ True positives, from the perspective of the query data, i.e. the number of sites in the Query Call Set for which there are paths through the Truth Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.
-
truthFN¶ False negatives, i.e. the number of sites in the Truth Call Set for which there is no path through the Query Call Set that is consistent with all of the alleles at this site, or sites for which there is an inaccurate genotype call for the event. Sites with correct variant but incorrect genotype are counted here.
-
queryFP¶ False positives, i.e. the number of sites in the Query Call Set for which there is no path through the Truth Call Set that is consistent with this site. Sites with correct variant but incorrect genotype are counted here.
-
gtFP¶ The number of false positives where the non-REF alleles in the Truth and Query Call Sets match (i.e. cases where the truth is 1/1 and the query is 0/1 or similar).
-
precision¶ QUERY.TP / (QUERY.TP + QUERY.FP).
-
recall¶ TRUTH.TP / (TRUTH.TP + TRUTH.FN).
-
fScore¶ Harmonic mean of Recall and Precision, computed as: 2 * precision * recall / (precision + recall).
-
-
class
cardea.fhir.Sequence.Sequence_ReferenceSeq(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRaw data describing a biological sequence.
-
chromosome¶ Structural unit composed of a nucleic acid molecule which controls its own replication through the interaction of specific proteins at one or more origins of replication ([SO:0000340](http://www.sequenceontology.org/browser/current_svn/term/SO:0000340)).
-
genomeBuild¶ The Genome Build used for reference, following GRCh build versions e.g. ‘GRCh 37’. Version number must be included if a versioned release of a primary build was used.
-
referenceSeqId¶ Reference identifier of reference sequence submitted to NCBI. It must match the type in the Sequence.type field. For example, the prefix, “NG_” identifies reference sequence for genes, “NM_” for messenger RNA transcripts, and “NP_” for amino acid sequences.
-
referenceSeqPointer¶ A Pointer to another Sequence entity as reference sequence.
-
referenceSeqString¶ A string like “ACGT”.
-
strand¶ Directionality of DNA sequence. Available values are “1” for the plus strand (5’ to 3’)/Watson/Sense/positive and “-1” for the minus strand(3’ to 5’)/Crick/Antisense/negative.
-
windowStart¶ Start position of the window on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.
-
windowEnd¶ End position of the window on the reference sequence. If the coordinate system is 0-based then end is is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.
-
-
class
cardea.fhir.Sequence.Sequence_Repository(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRaw data describing a biological sequence.
-
type¶ Click and see / RESTful API / Need login to see / RESTful API with authentication / Other ways to see resource.
-
url¶ URI of an external repository which contains further details about the genetics data.
-
name¶ URI of an external repository which contains further details about the genetics data.
-
datasetId¶ Id of the variant in this external repository. The server will understand how to use this id to call for more info about datasets in external repository.
-
variantsetId¶ Id of the variantset in this external repository. The server will understand how to use this id to call for more info about variantsets in external repository.
-
readsetId¶ Id of the read in this external repository.
-
-
class
cardea.fhir.Sequence.Sequence_Variant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRaw data describing a biological sequence.
-
start¶ Start position of the variant on the reference sequence.If the coordinate system is either 0-based or 1-based, then start position is inclusive.
-
end¶ End position of the variant on the reference sequence.If the coordinate system is 0-based then end is is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.
-
observedAllele¶ An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the observed sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.
-
referenceAllele¶ An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the reference sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.
-
cigar¶ Extended CIGAR string for aligning the sequence with reference bases. See detailed documentation [here](http://support.illumina.com/help/SequencingAnalysisWorkflow/Content/Vault/Informatics/Sequencing_Analysis/CASAVA/swSEQ_mCA_ExtendedCIGARFormat.htm).
-
variantPointer¶ A pointer to an Observation containing variant information.
-
cardea.fhir.ServiceDefinition module¶
-
class
cardea.fhir.ServiceDefinition.ServiceDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe ServiceDefinition describes a unit of decision support functionality that is made available as a service, such as immunization modules or drug-drug interaction checking.
-
resourceType¶ This is a ServiceDefinition resource
-
url¶ An absolute URI that is used to identify this service definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this service definition is (or will be) published. The URL SHOULD include the major version of the service definition. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this service definition when it is represented in other formats, or referenced in a specification, model, design or an instance. This is used for CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.
-
version¶ The identifier that is used to identify this version of the service definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the service definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the service definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the service definition.
-
status¶ The status of this service definition. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this service definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the service definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the service definition changes.
-
publisher¶ The name of the individual or organization that published the service definition.
-
description¶ A free text natural language description of the service definition from a consumer’s perspective.
-
purpose¶ Explaination of why this service definition is needed and why it has been designed as it has.
-
usage¶ A detailed description of how the module is used from a clinical perspective.
-
approvalDate¶ The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate¶ The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn’t change the original approval date.
-
effectivePeriod¶ The period during which the service definition content was or is planned to be in active use.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate service definition instances.
-
jurisdiction¶ A legal or geographic region in which the service definition is intended to be used.
-
topic¶ Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
-
contributor¶ A contributor to the content of the module, including authors, editors, reviewers, and endorsers.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
copyright¶ A copyright statement relating to the service definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the service definition.
Related resources such as additional documentation, justification, or bibliographic references.
-
trigger¶ The trigger element defines when the rule should be invoked. This information is used by consumers of the rule to determine how to integrate the rule into a specific workflow.
-
dataRequirement¶ Data requirements are a machine processable description of the data required by the module in order to perform a successful evaluation.
-
operationDefinition¶ A reference to the operation that is used to invoke this service.
-
cardea.fhir.Signature module¶
-
class
cardea.fhir.Signature.Signature(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA digital signature along with supporting context. The signature may be electronic/cryptographic in nature, or a graphical image representing a hand-written signature, or a signature process. Different signature approaches have different utilities.
-
type¶ An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.
-
when¶ When the digital signature was signed.
-
whoUri¶ A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).
-
whoReference¶ A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).
-
onBehalfOfUri¶ A reference to an application-usable description of the identity that is represented by the signature.
-
onBehalfOfReference¶ A reference to an application-usable description of the identity that is represented by the signature.
-
contentType¶ A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jwt for JWT, and image/* for a graphical image of a signature, etc.
-
blob¶ The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
-
cardea.fhir.Slot module¶
-
class
cardea.fhir.Slot.Slot(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA slot of time on a schedule that may be available for booking appointments.
-
resourceType¶ This is a Slot resource
-
identifier¶ External Ids for this item.
-
serviceCategory¶ A broad categorisation of the service that is to be performed during this appointment.
-
serviceType¶ The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.
-
specialty¶ The specialty of a practitioner that would be required to perform the service requested in this appointment.
-
appointmentType¶ The style of appointment or patient that may be booked in the slot (not service type).
-
schedule¶ The schedule resource that this slot defines an interval of status information.
-
status¶ busy | free | busy-unavailable | busy-tentative | entered-in-error.
-
start¶ Date/Time that the slot is to begin.
-
end¶ Date/Time that the slot is to conclude.
-
overbooked¶ This slot has already been overbooked, appointments are unlikely to be accepted for this time.
-
comment¶ Comments on the slot to describe any extended information. Such as custom constraints on the slot.
-
cardea.fhir.Specimen module¶
-
class
cardea.fhir.Specimen.Specimen(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA sample to be used for analysis.
-
resourceType¶ This is a Specimen resource
-
identifier¶ Id for specimen.
-
accessionIdentifier¶ The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
-
status¶ The availability of the specimen.
-
type¶ The kind of material that forms the specimen.
-
subject¶ Where the specimen came from. This may be from the patient(s) or from the environment or a device.
-
receivedTime¶ Time when specimen was received for processing or testing.
-
parent¶ Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
-
request¶ Details concerning a test or procedure request that required a specimen to be collected.
-
collection¶ Details concerning the specimen collection.
-
processing¶ Details concerning processing and processing steps for the specimen.
-
container¶ The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
-
note¶ To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
-
-
class
cardea.fhir.Specimen.Specimen_Collection(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA sample to be used for analysis.
-
collector¶ Person who collected the specimen.
-
collectedDateTime¶ Time when specimen was collected from subject - the physiologically relevant time.
-
collectedPeriod¶ Time when specimen was collected from subject - the physiologically relevant time.
-
quantity¶ The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.
-
method¶ A coded value specifying the technique that is used to perform the procedure.
-
bodySite¶ Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.
-
-
class
cardea.fhir.Specimen.Specimen_Container(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA sample to be used for analysis.
-
identifier¶ Id for container. There may be multiple; a manufacturer’s bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.
-
description¶ Textual description of the container.
-
type¶ The type of container associated with the specimen (e.g. slide, aliquot, etc.).
-
capacity¶ The capacity (volume or other measure) the container may contain.
-
specimenQuantity¶ The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.
-
additiveCodeableConcept¶ Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
-
additiveReference¶ Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
-
-
class
cardea.fhir.Specimen.Specimen_Processing(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA sample to be used for analysis.
-
description¶ Textual description of procedure.
-
procedure¶ A coded value specifying the procedure used to process the specimen.
-
additive¶ Material used in the processing step.
-
timeDateTime¶ A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.
-
timePeriod¶ A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.
-
cardea.fhir.StructureDefinition module¶
-
class
cardea.fhir.StructureDefinition.StructureDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
-
resourceType¶ This is a StructureDefinition resource
-
url¶ An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure definition is (or will be) published. The URL SHOULD include the major version of the structure definition. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the structure definition.
-
status¶ The status of this structure definition. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the structure definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure definition changes.
-
publisher¶ The name of the individual or organization that published the structure definition.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the structure definition from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate structure definition instances.
-
jurisdiction¶ A legal or geographic region in which the structure definition is intended to be used.
-
purpose¶ Explaination of why this structure definition is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition.
-
keyword¶ A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates.
-
fhirVersion¶ The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.1 for this version.
-
mapping¶ An external specification that the content is mapped to.
-
kind¶ Defines the kind of structure that this definition is describing.
-
abstract¶ Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.
-
contextType¶ If this is an extension, Identifies the context within FHIR resources where the extension can be used.
-
context¶ Identifies the types of resource or data type elements to which the extension can be applied.
-
contextInvariant¶ A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).
-
type¶ The type this structure describes. If the derivation kind is ‘specialization’ then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type).
-
baseDefinition¶ An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
-
derivation¶ How the type relates to the baseDefinition.
-
snapshot¶ A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.
-
differential¶ A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.
-
-
class
cardea.fhir.StructureDefinition.StructureDefinition_Differential(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
-
element¶ Captures constraints on each element within the resource.
-
-
class
cardea.fhir.StructureDefinition.StructureDefinition_Mapping(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
-
identity¶ An Internal id that is used to identify this mapping set when specific mappings are made.
-
uri¶ An absolute URI that identifies the specification that this mapping is expressed to.
-
name¶ A name for the specification that is being mapped to.
-
comment¶ Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.
-
-
class
cardea.fhir.StructureDefinition.StructureDefinition_Snapshot(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
-
element¶ Captures constraints on each element within the resource.
-
cardea.fhir.StructureMap module¶
-
class
cardea.fhir.StructureMap.StructureMap(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
resourceType¶ This is a StructureMap resource
-
url¶ An absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure map is (or will be) published. The URL SHOULD include the major version of the structure map. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the structure map.
-
status¶ The status of this structure map. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the structure map was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changes.
-
publisher¶ The name of the individual or organization that published the structure map.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the structure map from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate structure map instances.
-
jurisdiction¶ A legal or geographic region in which the structure map is intended to be used.
-
purpose¶ Explaination of why this structure map is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.
-
structure¶ A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
-
import¶ Other maps used by this map (canonical URLs).
-
group¶ Organizes the mapping into managable chunks for human review/ease of maintenance.
-
-
class
cardea.fhir.StructureMap.StructureMap_Dependent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
name¶ Name of a rule or group to apply.
-
variable¶ Variable to pass to the rule or group.
-
-
class
cardea.fhir.StructureMap.StructureMap_Group(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
name¶ A unique name for the group for the convenience of human readers.
-
extends¶ Another group that this group adds rules to.
-
typeMode¶ If this is the default rule set to apply for thie source type, or this combination of types.
-
documentation¶ Additional supporting documentation that explains the purpose of the group and the types of mappings within it.
-
input¶ A name assigned to an instance of data. The instance must be provided when the mapping is invoked.
-
rule¶ Transform Rule from source to target.
-
-
class
cardea.fhir.StructureMap.StructureMap_Input(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
name¶ Name for this instance of data.
-
type¶ Type for this instance of data.
-
mode¶ Mode for this instance of data.
-
documentation¶ Documentation for this instance of data.
-
-
class
cardea.fhir.StructureMap.StructureMap_Parameter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
valueId¶ Parameter value - variable or literal.
-
valueString¶ Parameter value - variable or literal.
-
valueBoolean¶ Parameter value - variable or literal.
-
valueInteger¶ Parameter value - variable or literal.
-
valueDecimal¶ Parameter value - variable or literal.
-
-
class
cardea.fhir.StructureMap.StructureMap_Rule(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
name¶ Name of the rule for internal references.
-
source¶ Source inputs to the mapping.
-
target¶ Content to create because of this mapping rule.
-
rule¶ Rules contained in this rule.
-
dependent¶ Which other rules to apply in the context of this rule.
-
documentation¶ Documentation for this instance of data.
-
-
class
cardea.fhir.StructureMap.StructureMap_Source(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
context¶ Type or variable this rule applies to.
-
min¶ Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.
-
max¶ Specified maximum cardinality for the element - a number or a “*”. This is optional; if present, it acts an implicit check on the input content (* just serves as documentation; it’s the default value).
-
type¶ Specified type for the element. This works as a condition on the mapping - use for polymorphic elements.
-
defaultValueBoolean¶ A value to use if there is no existing value in the source object.
-
defaultValueInteger¶ A value to use if there is no existing value in the source object.
-
defaultValueDecimal¶ A value to use if there is no existing value in the source object.
-
defaultValueBase64Binary¶ A value to use if there is no existing value in the source object.
-
defaultValueInstant¶ A value to use if there is no existing value in the source object.
-
defaultValueString¶ A value to use if there is no existing value in the source object.
-
defaultValueUri¶ A value to use if there is no existing value in the source object.
-
defaultValueDate¶ A value to use if there is no existing value in the source object.
-
defaultValueDateTime¶ A value to use if there is no existing value in the source object.
-
defaultValueTime¶ A value to use if there is no existing value in the source object.
-
defaultValueCode¶ A value to use if there is no existing value in the source object.
-
defaultValueOid¶ A value to use if there is no existing value in the source object.
-
defaultValueUuid¶ A value to use if there is no existing value in the source object.
-
defaultValueId¶ A value to use if there is no existing value in the source object.
-
defaultValueUnsignedInt¶ A value to use if there is no existing value in the source object.
-
defaultValuePositiveInt¶ A value to use if there is no existing value in the source object.
-
defaultValueMarkdown¶ A value to use if there is no existing value in the source object.
-
defaultValueElement¶ A value to use if there is no existing value in the source object.
-
defaultValueExtension¶ A value to use if there is no existing value in the source object.
-
defaultValueBackboneElement¶ A value to use if there is no existing value in the source object.
-
defaultValueNarrative¶ A value to use if there is no existing value in the source object.
-
defaultValueAnnotation¶ A value to use if there is no existing value in the source object.
-
defaultValueAttachment¶ A value to use if there is no existing value in the source object.
-
defaultValueIdentifier¶ A value to use if there is no existing value in the source object.
-
defaultValueCodeableConcept¶ A value to use if there is no existing value in the source object.
-
defaultValueCoding¶ A value to use if there is no existing value in the source object.
-
defaultValueQuantity¶ A value to use if there is no existing value in the source object.
-
defaultValueDuration¶ A value to use if there is no existing value in the source object.
-
defaultValueSimpleQuantity¶ A value to use if there is no existing value in the source object.
-
defaultValueDistance¶ A value to use if there is no existing value in the source object.
-
defaultValueCount¶ A value to use if there is no existing value in the source object.
-
defaultValueMoney¶ A value to use if there is no existing value in the source object.
-
defaultValueAge¶ A value to use if there is no existing value in the source object.
-
defaultValueRange¶ A value to use if there is no existing value in the source object.
-
defaultValuePeriod¶ A value to use if there is no existing value in the source object.
-
defaultValueRatio¶ A value to use if there is no existing value in the source object.
-
defaultValueReference¶ A value to use if there is no existing value in the source object.
-
defaultValueSampledData¶ A value to use if there is no existing value in the source object.
-
defaultValueSignature¶ A value to use if there is no existing value in the source object.
-
defaultValueHumanName¶ A value to use if there is no existing value in the source object.
-
defaultValueAddress¶ A value to use if there is no existing value in the source object.
-
defaultValueContactPoint¶ A value to use if there is no existing value in the source object.
-
defaultValueTiming¶ A value to use if there is no existing value in the source object.
-
defaultValueMeta¶ A value to use if there is no existing value in the source object.
-
defaultValueElementDefinition¶ A value to use if there is no existing value in the source object.
-
defaultValueContactDetail¶ A value to use if there is no existing value in the source object.
-
defaultValueContributor¶ A value to use if there is no existing value in the source object.
-
defaultValueDosage¶ A value to use if there is no existing value in the source object.
-
defaultValueRelatedArtifact¶ A value to use if there is no existing value in the source object.
-
defaultValueUsageContext¶ A value to use if there is no existing value in the source object.
-
defaultValueDataRequirement¶ A value to use if there is no existing value in the source object.
-
defaultValueParameterDefinition¶ A value to use if there is no existing value in the source object.
-
defaultValueTriggerDefinition¶ A value to use if there is no existing value in the source object.
-
element¶ Optional field for this source.
-
listMode¶ How to handle the list mode for this element.
-
variable¶ Named context for field, if a field is specified.
-
condition¶ FHIRPath expression - must be true or the rule does not apply.
-
check¶ FHIRPath expression - must be true or the mapping engine throws an error instead of completing.
-
-
class
cardea.fhir.StructureMap.StructureMap_Structure(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
url¶ The canonical URL that identifies the structure.
-
mode¶ How the referenced structure is used in this mapping.
-
alias¶ The name used for this type in the map.
-
documentation¶ Documentation that describes how the structure is used in the mapping.
-
-
class
cardea.fhir.StructureMap.StructureMap_Target(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
context¶ Type or variable this rule applies to.
-
contextType¶ How to interpret the context.
-
element¶ Field to create in the context.
-
variable¶ Named context for field, if desired, and a field is specified.
-
listMode¶ If field is a list, how to manage the list.
-
listRuleId¶ Internal rule reference for shared list items.
-
transform¶ How the data is copied / created.
-
parameter¶ Parameters to the transform.
-
cardea.fhir.Subscription module¶
-
class
cardea.fhir.Subscription.Subscription(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe subscription resource is used to define a push based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined “channel” so that another system is able to take an appropriate action.
-
resourceType¶ This is a Subscription resource
-
status¶ The status of the subscription, which marks the server state for managing the subscription.
-
contact¶ Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
-
end¶ The time for the server to turn the subscription off.
-
reason¶ A description of why this subscription is defined.
-
criteria¶ The rules that the server should use to determine when to generate notifications for this subscription.
-
error¶ A record of the last error that occurred when the server processed a notification.
-
channel¶ Details where to send notifications when resources are received that meet the criteria.
-
tag¶ A tag to add to any resource that matches the criteria, after the subscription is processed.
-
-
class
cardea.fhir.Subscription.Subscription_Channel(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe subscription resource is used to define a push based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined “channel” so that another system is able to take an appropriate action.
-
type¶ The type of channel to send notifications on.
-
endpoint¶ The uri that describes the actual end-point to send messages to.
-
payload¶ The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification.
-
header¶ Additional headers / information to send as part of the notification.
-
cardea.fhir.Substance module¶
-
class
cardea.fhir.Substance.Substance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA homogeneous material with a definite composition.
-
resourceType¶ This is a Substance resource
-
identifier¶ Unique identifier for the substance.
-
status¶ A code to indicate if the substance is actively used.
-
category¶ A code that classifies the general type of substance. This is used for searching, sorting and display purposes.
-
code¶ A code (or set of codes) that identify this substance.
-
description¶ A description of the substance - its appearance, handling requirements, and other usage notes.
-
instance¶ Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.
-
ingredient¶ A substance can be composed of other substances.
-
-
class
cardea.fhir.Substance.Substance_Ingredient(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA homogeneous material with a definite composition.
-
quantity¶ The amount of the ingredient in the substance - a concentration ratio.
-
substanceCodeableConcept¶ Another substance that is a component of this substance.
-
substanceReference¶ Another substance that is a component of this substance.
-
-
class
cardea.fhir.Substance.Substance_Instance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA homogeneous material with a definite composition.
-
identifier¶ Identifier associated with the package/container (usually a label affixed directly).
-
expiry¶ When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.
-
quantity¶ The amount of the substance.
-
cardea.fhir.SupplyDelivery module¶
-
class
cardea.fhir.SupplyDelivery.SupplyDelivery(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRecord of delivery of what is supplied.
-
resourceType¶ This is a SupplyDelivery resource
-
identifier¶ Identifier assigned by the dispensing facility when the item(s) is dispensed.
-
basedOn¶ A plan, proposal or order that is fulfilled in whole or in part by this event.
-
partOf¶ A larger event of which this particular event is a component or step.
-
status¶ A code specifying the state of the dispense event.
-
patient¶ A link to a resource representing the person whom the delivered item is for.
-
type¶ Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
-
suppliedItem¶ The item that is being delivered or has been supplied.
-
occurrenceDateTime¶ The date or time(s) the activity occurred.
-
occurrencePeriod¶ The date or time(s) the activity occurred.
-
occurrenceTiming¶ The date or time(s) the activity occurred.
-
supplier¶ The individual responsible for dispensing the medication, supplier or device.
-
destination¶ Identification of the facility/location where the Supply was shipped to, as part of the dispense event.
-
receiver¶ Identifies the person who picked up the Supply.
-
-
class
cardea.fhir.SupplyDelivery.SupplyDelivery_SuppliedItem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRecord of delivery of what is supplied.
-
quantity¶ The amount of supply that has been dispensed. Includes unit of measure.
-
itemCodeableConcept¶ Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
-
itemReference¶ Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
-
cardea.fhir.SupplyRequest module¶
-
class
cardea.fhir.SupplyRequest.SupplyRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a request for a medication, substance or device used in the healthcare setting.
-
resourceType¶ This is a SupplyRequest resource
-
identifier¶ Unique identifier for this supply request.
-
status¶ Status of the supply request.
-
category¶ Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
-
priority¶ Indicates how quickly this SupplyRequest should be addressed with respect to other requests.
-
orderedItem¶ The item being requested.
-
occurrenceDateTime¶ When the request should be fulfilled.
-
occurrencePeriod¶ When the request should be fulfilled.
-
occurrenceTiming¶ When the request should be fulfilled.
When the request was made.
-
requester¶ The individual who initiated the request and has responsibility for its activation.
-
supplier¶ Who is intended to fulfill the request.
-
reasonCodeableConcept¶ Why the supply item was requested.
-
reasonReference¶ Why the supply item was requested.
-
deliverFrom¶ Where the supply is expected to come from.
-
deliverTo¶ Where the supply is destined to go.
-
-
class
cardea.fhir.SupplyRequest.SupplyRequest_OrderedItem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a request for a medication, substance or device used in the healthcare setting.
-
quantity¶ The amount that is being ordered of the indicated item.
-
itemCodeableConcept¶ The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
-
itemReference¶ The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
-
-
class
cardea.fhir.SupplyRequest.SupplyRequest_Requester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a request for a medication, substance or device used in the healthcare setting.
-
agent¶ The device, practitioner, etc. who initiated the request.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
cardea.fhir.Task module¶
-
class
cardea.fhir.Task.Task(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA task to be performed.
-
resourceType¶ This is a Task resource
-
identifier¶ The business identifier for this task.
-
definitionUri¶ A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.
-
definitionReference¶ A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.
-
basedOn¶ BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a “request” resource such as a ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the “request” resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.
-
groupIdentifier¶ An identifier that links together multiple tasks and other requests that were created in the same context.
-
partOf¶ Task that this particular task is part of.
-
status¶ The current status of the task.
-
statusReason¶ An explanation as to why this task is held, failed, was refused, etc.
-
businessStatus¶ Contains business-specific nuances of the business state.
-
intent¶ Indicates the “level” of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.
-
priority¶ Indicates how quickly the Task should be addressed with respect to other requests.
-
code¶ A name or code (or both) briefly describing what the task involves.
-
description¶ A free-text description of what is to be performed.
-
focus¶ The request being actioned or the resource being manipulated by this task.
-
for¶ The entity who benefits from the performance of the service specified in the task (e.g., the patient).
-
context¶ The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
-
executionPeriod¶ Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).
The date and time this task was created.
-
lastModified¶ The date and time of last modification to this task.
-
requester¶ The creator of the task.
-
performerType¶ The type of participant that can execute the task.
-
owner¶ Individual organization or Device currently responsible for task execution.
-
reason¶ A description or code indicating why this task needs to be performed.
-
note¶ Free-text information captured about the task as it progresses.
-
relevantHistory¶ Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.
-
restriction¶ If the Task.focus is a request resource and the task is seeking fulfillment (i.e is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
-
input¶ Additional information that may be needed in the execution of the task.
-
output¶ Outputs produced by the Task.
-
-
class
cardea.fhir.Task.Task_Input(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA task to be performed.
-
type¶ A code or description indicating how the input is intended to be used as part of the task execution.
-
valueBoolean¶ The value of the input parameter as a basic type.
-
valueInteger¶ The value of the input parameter as a basic type.
-
valueDecimal¶ The value of the input parameter as a basic type.
-
valueBase64Binary¶ The value of the input parameter as a basic type.
-
valueInstant¶ The value of the input parameter as a basic type.
-
valueString¶ The value of the input parameter as a basic type.
-
valueUri¶ The value of the input parameter as a basic type.
-
valueDate¶ The value of the input parameter as a basic type.
-
valueDateTime¶ The value of the input parameter as a basic type.
-
valueTime¶ The value of the input parameter as a basic type.
-
valueCode¶ The value of the input parameter as a basic type.
-
valueOid¶ The value of the input parameter as a basic type.
-
valueUuid¶ The value of the input parameter as a basic type.
-
valueId¶ The value of the input parameter as a basic type.
-
valueUnsignedInt¶ The value of the input parameter as a basic type.
-
valuePositiveInt¶ The value of the input parameter as a basic type.
-
valueMarkdown¶ The value of the input parameter as a basic type.
-
valueElement¶ The value of the input parameter as a basic type.
-
valueExtension¶ The value of the input parameter as a basic type.
-
valueBackboneElement¶ The value of the input parameter as a basic type.
-
valueNarrative¶ The value of the input parameter as a basic type.
-
valueAnnotation¶ The value of the input parameter as a basic type.
-
valueAttachment¶ The value of the input parameter as a basic type.
-
valueIdentifier¶ The value of the input parameter as a basic type.
-
valueCodeableConcept¶ The value of the input parameter as a basic type.
-
valueCoding¶ The value of the input parameter as a basic type.
-
valueQuantity¶ The value of the input parameter as a basic type.
-
valueDuration¶ The value of the input parameter as a basic type.
-
valueSimpleQuantity¶ The value of the input parameter as a basic type.
-
valueDistance¶ The value of the input parameter as a basic type.
-
valueCount¶ The value of the input parameter as a basic type.
-
valueMoney¶ The value of the input parameter as a basic type.
-
valueAge¶ The value of the input parameter as a basic type.
-
valueRange¶ The value of the input parameter as a basic type.
-
valuePeriod¶ The value of the input parameter as a basic type.
-
valueRatio¶ The value of the input parameter as a basic type.
-
valueReference¶ The value of the input parameter as a basic type.
-
valueSampledData¶ The value of the input parameter as a basic type.
-
valueSignature¶ The value of the input parameter as a basic type.
-
valueHumanName¶ The value of the input parameter as a basic type.
-
valueAddress¶ The value of the input parameter as a basic type.
-
valueContactPoint¶ The value of the input parameter as a basic type.
-
valueTiming¶ The value of the input parameter as a basic type.
-
valueMeta¶ The value of the input parameter as a basic type.
-
valueElementDefinition¶ The value of the input parameter as a basic type.
-
valueContactDetail¶ The value of the input parameter as a basic type.
-
valueContributor¶ The value of the input parameter as a basic type.
-
valueDosage¶ The value of the input parameter as a basic type.
-
valueRelatedArtifact¶ The value of the input parameter as a basic type.
-
valueUsageContext¶ The value of the input parameter as a basic type.
-
valueDataRequirement¶ The value of the input parameter as a basic type.
-
valueParameterDefinition¶ The value of the input parameter as a basic type.
-
valueTriggerDefinition¶ The value of the input parameter as a basic type.
-
-
class
cardea.fhir.Task.Task_Output(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA task to be performed.
-
type¶ The name of the Output parameter.
-
valueBoolean¶ The value of the Output parameter as a basic type.
-
valueInteger¶ The value of the Output parameter as a basic type.
-
valueDecimal¶ The value of the Output parameter as a basic type.
-
valueBase64Binary¶ The value of the Output parameter as a basic type.
-
valueInstant¶ The value of the Output parameter as a basic type.
-
valueString¶ The value of the Output parameter as a basic type.
-
valueUri¶ The value of the Output parameter as a basic type.
-
valueDate¶ The value of the Output parameter as a basic type.
-
valueDateTime¶ The value of the Output parameter as a basic type.
-
valueTime¶ The value of the Output parameter as a basic type.
-
valueCode¶ The value of the Output parameter as a basic type.
-
valueOid¶ The value of the Output parameter as a basic type.
-
valueUuid¶ The value of the Output parameter as a basic type.
-
valueId¶ The value of the Output parameter as a basic type.
-
valueUnsignedInt¶ The value of the Output parameter as a basic type.
-
valuePositiveInt¶ The value of the Output parameter as a basic type.
-
valueMarkdown¶ The value of the Output parameter as a basic type.
-
valueElement¶ The value of the Output parameter as a basic type.
-
valueExtension¶ The value of the Output parameter as a basic type.
-
valueBackboneElement¶ The value of the Output parameter as a basic type.
-
valueNarrative¶ The value of the Output parameter as a basic type.
-
valueAnnotation¶ The value of the Output parameter as a basic type.
-
valueAttachment¶ The value of the Output parameter as a basic type.
-
valueIdentifier¶ The value of the Output parameter as a basic type.
-
valueCodeableConcept¶ The value of the Output parameter as a basic type.
-
valueCoding¶ The value of the Output parameter as a basic type.
-
valueQuantity¶ The value of the Output parameter as a basic type.
-
valueDuration¶ The value of the Output parameter as a basic type.
-
valueSimpleQuantity¶ The value of the Output parameter as a basic type.
-
valueDistance¶ The value of the Output parameter as a basic type.
-
valueCount¶ The value of the Output parameter as a basic type.
-
valueMoney¶ The value of the Output parameter as a basic type.
-
valueAge¶ The value of the Output parameter as a basic type.
-
valueRange¶ The value of the Output parameter as a basic type.
-
valuePeriod¶ The value of the Output parameter as a basic type.
-
valueRatio¶ The value of the Output parameter as a basic type.
-
valueReference¶ The value of the Output parameter as a basic type.
-
valueSampledData¶ The value of the Output parameter as a basic type.
-
valueSignature¶ The value of the Output parameter as a basic type.
-
valueHumanName¶ The value of the Output parameter as a basic type.
-
valueAddress¶ The value of the Output parameter as a basic type.
-
valueContactPoint¶ The value of the Output parameter as a basic type.
-
valueTiming¶ The value of the Output parameter as a basic type.
-
valueMeta¶ The value of the Output parameter as a basic type.
-
valueElementDefinition¶ The value of the Output parameter as a basic type.
-
valueContactDetail¶ The value of the Output parameter as a basic type.
-
valueContributor¶ The value of the Output parameter as a basic type.
-
valueDosage¶ The value of the Output parameter as a basic type.
-
valueRelatedArtifact¶ The value of the Output parameter as a basic type.
-
valueUsageContext¶ The value of the Output parameter as a basic type.
-
valueDataRequirement¶ The value of the Output parameter as a basic type.
-
valueParameterDefinition¶ The value of the Output parameter as a basic type.
-
valueTriggerDefinition¶ The value of the Output parameter as a basic type.
-
-
class
cardea.fhir.Task.Task_Requester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA task to be performed.
-
agent¶ The device, practitioner, etc. who initiated the task.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of when they initiated the task.
-
-
class
cardea.fhir.Task.Task_Restriction(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA task to be performed.
-
repetitions¶ Indicates the number of times the requested action should occur.
-
period¶ Over what time-period is fulfillment sought.
-
recipient¶ For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?
-
cardea.fhir.TestReport module¶
-
class
cardea.fhir.TestReport.TestReport(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
resourceType¶ This is a TestReport resource
-
identifier¶ Identifier for the TestScript assigned for external purposes outside the context of FHIR.
-
name¶ A free text natural language name identifying the executed TestScript.
-
status¶ The current state of this test report.
-
testScript¶ Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the TestScript.url.
-
result¶ The overall result from the execution of the TestScript.
-
score¶ The final score (percentage of tests passed) resulting from the execution of the TestScript.
-
tester¶ Name of the tester producing this report (Organization or individual).
-
issued¶ When the TestScript was executed and this TestReport was generated.
-
participant¶ A participant in the test execution, either the execution engine, a client, or a server.
-
setup¶ The results of the series of required setup operations before the tests were executed.
-
test¶ A test executed from the test script.
-
teardown¶ The results of the series of operations required to clean up after the all the tests were executed (successfully or otherwise).
-
-
class
cardea.fhir.TestReport.TestReport_Action(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
operation¶ The operation performed.
-
assert¶ The results of the assertion performed on the previous operations.
-
-
class
cardea.fhir.TestReport.TestReport_Action1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
operation¶ An operation would involve a REST request to a server.
-
assert¶ The results of the assertion performed on the previous operations.
-
-
class
cardea.fhir.TestReport.TestReport_Action2(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
operation¶ An operation would involve a REST request to a server.
-
-
class
cardea.fhir.TestReport.TestReport_Assert(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
result¶ The result of this assertion.
-
message¶ An explanatory message associated with the result.
-
detail¶ A link to further details on the result.
-
-
class
cardea.fhir.TestReport.TestReport_Operation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
result¶ The result of this operation.
-
message¶ An explanatory message associated with the result.
-
detail¶ A link to further details on the result.
-
-
class
cardea.fhir.TestReport.TestReport_Participant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
type¶ The type of participant.
-
uri¶ The uri of the participant. An absolute URL is preferred.
-
display¶ The display name of the participant.
-
-
class
cardea.fhir.TestReport.TestReport_Setup(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
action¶ Action would contain either an operation or an assertion.
-
-
class
cardea.fhir.TestReport.TestReport_Teardown(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
action¶ The teardown action will only contain an operation.
-
-
class
cardea.fhir.TestReport.TestReport_Test(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
name¶ The name of this test used for tracking/logging purposes by test engines.
-
description¶ A short description of the test used by test engines for tracking and reporting purposes.
-
action¶ Action would contain either an operation or an assertion.
-
cardea.fhir.TestScript module¶
-
class
cardea.fhir.TestScript.TestScript(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
resourceType¶ This is a TestScript resource
-
url¶ An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this test script is (or will be) published. The URL SHOULD include the major version of the test script. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the test script.
-
status¶ The status of this test script. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the test script was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes.
-
publisher¶ The name of the individual or organization that published the test script.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the test script from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate test script instances.
-
jurisdiction¶ A legal or geographic region in which the test script is intended to be used.
-
purpose¶ Explaination of why this test script is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.
-
origin¶ An abstract server used in operations within this test script in the origin element.
-
destination¶ An abstract server used in operations within this test script in the destination element.
-
metadata¶ The required capability must exist and are assumed to function correctly on the FHIR server being tested.
-
fixture¶ Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.
-
profile¶ Reference to the profile to be used for validation.
-
variable¶ Variable is set based either on element value in response body or on header field value in the response headers.
-
rule¶ Assert rule to be used in one or more asserts within the test script.
-
ruleset¶ Contains one or more rules. Offers a way to group rules so assertions could reference the group of rules and have them all applied.
-
setup¶ A series of required setup operations before tests are executed.
-
test¶ A test in this script.
-
teardown¶ A series of operations required to clean up after the all the tests are executed (successfully or otherwise).
-
-
class
cardea.fhir.TestScript.TestScript_Action(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
operation¶ The operation to perform.
-
assert¶ Evaluates the results of previous operations to determine if the server under test behaves appropriately.
-
-
class
cardea.fhir.TestScript.TestScript_Action1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
operation¶ An operation would involve a REST request to a server.
-
assert¶ Evaluates the results of previous operations to determine if the server under test behaves appropriately.
-
-
class
cardea.fhir.TestScript.TestScript_Action2(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
operation¶ An operation would involve a REST request to a server.
-
-
class
cardea.fhir.TestScript.TestScript_Assert(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
label¶ The label would be used for tracking/logging purposes by test engines.
-
description¶ The description would be used by test engines for tracking and reporting purposes.
-
direction¶ The direction to use for the assertion.
-
compareToSourceId¶ Id of the source fixture used as the contents to be evaluated by either the “source/expression” or “sourceId/path” definition.
-
compareToSourceExpression¶ The fluentpath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
-
compareToSourcePath¶ XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
-
contentType¶ The content-type or mime-type to use for RESTful operation in the ‘Content-Type’ header.
-
expression¶ The fluentpath expression to be evaluated against the request or response message contents - HTTP headers and payload.
-
headerField¶ The HTTP header field name e.g. ‘Location’.
-
minimumId¶ The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.
Whether or not the test execution performs validation on the bundle navigation links.
-
operator¶ The operator type defines the conditional behavior of the assert. If not defined, the default is equals.
-
path¶ The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.
-
requestMethod¶ The request method or HTTP operation code to compare against that used by the client system under test.
-
requestURL¶ The value to use in a comparison against the request URL path string.
-
resource¶ The type of the resource. See http://build.fhir.org/resourcelist.html.
-
response¶ okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable.
-
responseCode¶ The value of the HTTP response code to be tested.
-
rule¶ The TestScript.rule this assert will evaluate.
-
ruleset¶ The TestScript.ruleset this assert will evaluate.
-
sourceId¶ Fixture to evaluate the XPath/JSONPath expression or the headerField against.
-
validateProfileId¶ The ID of the Profile to validate against.
-
value¶ The value to compare to.
-
warningOnly¶ Whether or not the test execution will produce a warning only on error for this assert.
-
-
class
cardea.fhir.TestScript.TestScript_Capability(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
required¶ Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.
-
validated¶ Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.
-
description¶ Description of the capabilities that this test script is requiring the server to support.
-
origin¶ Which origin server these requirements apply to.
-
destination¶ Which server these requirements apply to.
-
link¶ Links to the FHIR specification that describes this interaction and the resources involved in more detail.
-
capabilities¶ Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped.
-
-
class
cardea.fhir.TestScript.TestScript_Destination(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
index¶ Abstract name given to a destination server in this test script. The name is provided as a number starting at 1.
-
profile¶ The type of destination profile the test system supports.
-
-
class
cardea.fhir.TestScript.TestScript_Fixture(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
autocreate¶ Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section.
-
autodelete¶ Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section.
-
resource¶ Reference to the resource (containing the contents of the resource needed for operations).
-
-
class
cardea.fhir.TestScript.TestScript_Link(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
url¶ URL to a particular requirement or feature within the FHIR specification.
-
description¶ Short description of the link.
-
-
class
cardea.fhir.TestScript.TestScript_Metadata(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
link¶ A link to the FHIR specification that this test is covering.
-
capability¶ Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.
-
-
class
cardea.fhir.TestScript.TestScript_Operation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
type¶ Server interaction or operation type.
-
resource¶ The type of the resource. See http://build.fhir.org/resourcelist.html.
-
label¶ The label would be used for tracking/logging purposes by test engines.
-
description¶ The description would be used by test engines for tracking and reporting purposes.
-
accept¶ The content-type or mime-type to use for RESTful operation in the ‘Accept’ header.
-
contentType¶ The content-type or mime-type to use for RESTful operation in the ‘Content-Type’ header.
-
destination¶ The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section.
-
encodeRequestUrl¶ Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths.
-
origin¶ The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.
-
params¶ Path plus parameters after [type]. Used to set parts of the request URL explicitly.
-
requestHeader¶ Header elements would be used to set HTTP headers.
-
requestId¶ The fixture id (maybe new) to map to the request.
-
responseId¶ The fixture id (maybe new) to map to the response.
-
sourceId¶ The id of the fixture used as the body of a PUT or POST request.
-
targetId¶ Id of fixture used for extracting the [id], [type], and [vid] for GET requests.
-
url¶ Complete request URL.
-
-
class
cardea.fhir.TestScript.TestScript_Origin(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
index¶ Abstract name given to an origin server in this test script. The name is provided as a number starting at 1.
-
profile¶ The type of origin profile the test system supports.
-
-
class
cardea.fhir.TestScript.TestScript_Param(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
name¶ Descriptive name for this parameter that matches the external assert rule parameter name.
-
value¶ The explicit or dynamic value for the parameter that will be passed on to the external rule template.
-
-
class
cardea.fhir.TestScript.TestScript_Param1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
name¶ Descriptive name for this parameter that matches the external assert ruleset rule parameter name.
-
value¶ The value for the parameter that will be passed on to the external ruleset rule template.
-
-
class
cardea.fhir.TestScript.TestScript_Param2(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
name¶ Descriptive name for this parameter that matches the external assert rule parameter name.
-
value¶ The value for the parameter that will be passed on to the external rule template.
-
-
class
cardea.fhir.TestScript.TestScript_Param3(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
name¶ Descriptive name for this parameter that matches the external assert ruleset rule parameter name.
-
value¶ The value for the parameter that will be passed on to the external ruleset rule template.
-
-
class
cardea.fhir.TestScript.TestScript_RequestHeader(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
field¶ The HTTP header field e.g. “Accept”.
-
value¶ The value of the header e.g. “application/fhir+xml”.
-
-
class
cardea.fhir.TestScript.TestScript_Rule(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
resource¶ Reference to the resource (containing the contents of the rule needed for assertions).
-
param¶ Each rule template can take one or more parameters for rule evaluation.
-
-
class
cardea.fhir.TestScript.TestScript_Rule1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
ruleId¶ Id of the referenced rule within the external ruleset template.
-
param¶ Each rule template can take one or more parameters for rule evaluation.
-
-
class
cardea.fhir.TestScript.TestScript_Rule2(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
ruleId¶ The TestScript.rule id value this assert will evaluate.
-
param¶ Each rule template can take one or more parameters for rule evaluation.
-
-
class
cardea.fhir.TestScript.TestScript_Rule3(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
ruleId¶ Id of the referenced rule within the external ruleset template.
-
param¶ Each rule template can take one or more parameters for rule evaluation.
-
-
class
cardea.fhir.TestScript.TestScript_Ruleset(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
resource¶ Reference to the resource (containing the contents of the ruleset needed for assertions).
-
rule¶ The referenced rule within the external ruleset template.
-
-
class
cardea.fhir.TestScript.TestScript_Ruleset1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
rulesetId¶ The TestScript.ruleset id value this assert will evaluate.
-
rule¶ The referenced rule within the external ruleset template.
-
-
class
cardea.fhir.TestScript.TestScript_Setup(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
action¶ Action would contain either an operation or an assertion.
-
-
class
cardea.fhir.TestScript.TestScript_Teardown(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
action¶ The teardown action will only contain an operation.
-
-
class
cardea.fhir.TestScript.TestScript_Test(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
name¶ The name of this test used for tracking/logging purposes by test engines.
-
description¶ A short description of the test used by test engines for tracking and reporting purposes.
-
action¶ Action would contain either an operation or an assertion.
-
-
class
cardea.fhir.TestScript.TestScript_Variable(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
name¶ Descriptive name for this variable.
-
defaultValue¶ A default, hard-coded, or user-defined value for this variable.
-
description¶ A free text natural language description of the variable and its purpose.
-
expression¶ The fluentpath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
-
headerField¶ Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.
-
hint¶ Displayable text string with hint help information to the user when entering a default value.
-
path¶ XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
-
sourceId¶ Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.
-
cardea.fhir.Timing module¶
-
class
cardea.fhir.Timing.Timing(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseSpecifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
-
event¶ Identifies specific times when the event occurs.
-
repeat¶ A set of rules that describe when the event is scheduled.
-
code¶ A code for the timing schedule. Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).
-
-
class
cardea.fhir.Timing.Timing_Repeat(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseSpecifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
-
boundsDuration¶ Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
-
boundsRange¶ Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
-
boundsPeriod¶ Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
-
count¶ A total count of the desired number of repetitions.
-
countMax¶ A maximum value for the count of the desired repetitions (e.g. do something 6-8 times).
-
duration¶ How long this thing happens for when it happens.
-
durationMax¶ The upper limit of how long this thing happens for when it happens.
-
durationUnit¶ The units of time for the duration, in UCUM units.
-
frequency¶ The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided).
-
frequencyMax¶ If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
-
period¶ Indicates the duration of time over which repetitions are to occur; e.g. to express “3 times per day”, 3 would be the frequency and “1 day” would be the period.
-
periodMax¶ If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as “do this once every 3-5 days.
-
periodUnit¶ The units of time for the period in UCUM units.
-
dayOfWeek¶ If one or more days of week is provided, then the action happens only on the specified day(s).
-
timeOfDay¶ Specified time of day for action to take place.
-
when¶ Real world events that the occurrence of the event should be tied to.
-
offset¶ The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
-
cardea.fhir.TriggerDefinition module¶
-
class
cardea.fhir.TriggerDefinition.TriggerDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA description of a triggering event.
-
type¶ The type of triggering event.
-
eventName¶ The name of the event (if this is a named-event trigger).
-
eventTimingTiming¶ The timing of the event (if this is a period trigger).
-
eventTimingReference¶ The timing of the event (if this is a period trigger).
-
eventTimingDate¶ The timing of the event (if this is a period trigger).
-
eventTimingDateTime¶ The timing of the event (if this is a period trigger).
-
eventData¶ The triggering data of the event (if this is a data trigger).
-
cardea.fhir.UsageContext module¶
-
class
cardea.fhir.UsageContext.UsageContext(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseSpecifies clinical/business/etc metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).
-
code¶ A code that identifies the type of context being specified by this usage context.
-
valueCodeableConcept¶ A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
-
valueQuantity¶ A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
-
valueRange¶ A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
-
cardea.fhir.ValueSet module¶
-
class
cardea.fhir.ValueSet.ValueSet(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
resourceType¶ This is a ValueSet resource
-
url¶ An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published. The URL SHOULD include the major version of the value set. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the value set.
-
status¶ The status of this value set. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the value set was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the value set changes. (e.g. the ‘content logical definition’).
-
publisher¶ The name of the individual or organization that published the value set.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the value set from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate value set instances.
-
jurisdiction¶ A legal or geographic region in which the value set is intended to be used.
-
immutable¶ If this is set to ‘true’, then no new versions of the content logical definition can be created. Note: Other metadata might still change.
-
purpose¶ Explaination of why this value set is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
-
extensible¶ Whether this is intended to be used with an extensible binding or not.
-
compose¶ A set of criteria that define the content logical definition of the value set by including or excluding codes from outside this value set. This I also known as the “Content Logical Definition” (CLD).
-
expansion¶ A value set can also be “expanded”, where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.
-
-
class
cardea.fhir.ValueSet.ValueSet_Compose(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
lockedDate¶ If a locked date is defined, then the Content Logical Definition must be evaluated using the current version as of the locked date for referenced code system(s) and value set instances where ValueSet.compose.include.version is not defined.
-
inactive¶ Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable ExpansionProfile (but generally, inactive codes would be expected to be included).
-
include¶ Include one or more codes from a code system or other value set(s).
-
exclude¶ Exclude one or more codes from the value set based on code system filters and/or other value sets.
-
-
class
cardea.fhir.ValueSet.ValueSet_Concept(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
code¶ Specifies a code for the concept to be included or excluded.
-
display¶ The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.
-
designation¶ Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.
-
-
class
cardea.fhir.ValueSet.ValueSet_Contains(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
system¶ An absolute URI which is the code system in which the code for this item in the expansion is defined.
-
abstract¶ If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.
-
inactive¶ If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data.
-
version¶ The version of this code system that defined this code and/or display. This should only be used with code systems that do not enforce concept permanence.
-
code¶ The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.
-
display¶ The recommended display for this item in the expansion.
-
designation¶ Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.
-
contains¶ Other codes and entries contained under this entry in the hierarchy.
-
-
class
cardea.fhir.ValueSet.ValueSet_Designation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
language¶ The language this designation is defined for.
-
use¶ A code that details how this designation would be used.
-
value¶ The text value for this designation.
-
-
class
cardea.fhir.ValueSet.ValueSet_Expansion(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
identifier¶ An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so.
-
timestamp¶ The time at which the expansion was produced by the expanding system.
-
total¶ The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.
-
offset¶ If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL not be present.
-
parameter¶ A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.
-
contains¶ The codes that are contained in the value set expansion.
-
-
class
cardea.fhir.ValueSet.ValueSet_Filter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
property¶ A code that identifies a property defined in the code system.
-
op¶ The kind of operation to perform as a part of the filter criteria.
-
value¶ The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value when the operation is ‘regex’, or one of the values (true and false), when the operation is ‘exists’.
-
-
class
cardea.fhir.ValueSet.ValueSet_Include(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
system¶ An absolute URI which is the code system from which the selected codes come from.
-
version¶ The version of the code system that the codes are selected from.
-
concept¶ Specifies a concept to be included or excluded.
-
filter¶ Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true.
-
valueSet¶ Selects concepts found in this value set. This is an absolute URI that is a reference to ValueSet.url.
-
-
class
cardea.fhir.ValueSet.ValueSet_Parameter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
name¶ The name of the parameter.
-
valueString¶ The value of the parameter.
-
valueBoolean¶ The value of the parameter.
-
valueInteger¶ The value of the parameter.
-
valueDecimal¶ The value of the parameter.
-
valueUri¶ The value of the parameter.
-
valueCode¶ The value of the parameter.
-
cardea.fhir.VisionPrescription module¶
-
class
cardea.fhir.VisionPrescription.VisionPrescription(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn authorization for the supply of glasses and/or contact lenses to a patient.
-
resourceType¶ This is a VisionPrescription resource
-
identifier¶ Business identifier which may be used by other parties to reference or identify the prescription.
-
status¶ The status of the resource instance.
-
patient¶ A link to a resource representing the person to whom the vision products will be supplied.
-
encounter¶ A link to a resource that identifies the particular occurrence of contact between patient and health care provider.
-
dateWritten¶ The date (and perhaps time) when the prescription was written.
-
prescriber¶ The healthcare professional responsible for authorizing the prescription.
-
reasonCodeableConcept¶ Can be the reason or the indication for writing the prescription.
-
reasonReference¶ Can be the reason or the indication for writing the prescription.
-
dispense¶ Deals with details of the dispense part of the supply specification.
-
-
class
cardea.fhir.VisionPrescription.VisionPrescription_Dispense(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn authorization for the supply of glasses and/or contact lenses to a patient.
-
product¶ Identifies the type of vision correction product which is required for the patient.
-
eye¶ The eye for which the lens applies.
-
sphere¶ Lens power measured in diopters (0.25 units).
-
cylinder¶ Power adjustment for astigmatism measured in diopters (0.25 units).
-
axis¶ Adjustment for astigmatism measured in integer degrees.
-
prism¶ Amount of prism to compensate for eye alignment in fractional units.
-
base¶ The relative base, or reference lens edge, for the prism.
-
add¶ Power adjustment for multifocal lenses measured in diopters (0.25 units).
-
power¶ Contact lens power measured in diopters (0.25 units).
-
backCurve¶ Back curvature measured in millimeters.
-
diameter¶ Contact lens diameter measured in millimeters.
-
duration¶ The recommended maximum wear period for the lens.
-
color¶ Special color or pattern.
-
brand¶ Brand recommendations or restrictions.
-
note¶ Notes for special requirements such as coatings and lens materials.
-
cardea.fhir.fhirbase module¶
-
class
cardea.fhir.fhirbase.fhirbase[source]¶ Bases:
object-
assert_type()[source]¶ Checks class values follow set possible enumerations.
Raises: ValueError– An error occurs if an attribute of the fhir class does not match its possible enumerations.
-
get_dataframe()[source]¶ Returns dataframe from class attribute values.
Returns: A dataframe representation of the class.
-
get_eligible_relationships()[source]¶ Returns class relationships for attributes that are used.
Returns: A list of the class’s associated relationships after filtering out attributes that are not used.
-
get_id()[source]¶ Returns fhir class identifier.
Returns: The name of identifier of the fhir class. Raises: LookupError– An error occurs if fhir class doesn’t have an id.
-
Module contents¶
-
class
cardea.fhir.Account(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
-
resourceType¶ This is a Account resource
-
identifier¶ Unique identifier used to reference the account. May or may not be intended for human use (e.g. credit card number).
-
status¶ Indicates whether the account is presently used/usable or not.
-
type¶ Categorizes the account for reporting and searching purposes.
-
name¶ Name used for the account when displaying it to humans in reports, etc.
-
subject¶ Identifies the patient, device, practitioner, location or other object the account is associated with.
-
period¶ Identifies the period of time the account applies to; e.g. accounts created per fiscal year, quarter, etc.
-
active¶ Indicates the period of time over which the account is allowed to have transactions posted to it. This period may be different to the coveragePeriod which is the duration of time that services may occur.
-
balance¶ Represents the sum of all credits less all debits associated with the account. Might be positive, zero or negative.
-
coverage¶ The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account.
-
owner¶ Indicates the organization, department, etc. with responsibility for the account.
-
description¶ Provides additional information about what the account tracks and how it is used.
-
guarantor¶ Parties financially responsible for the account.
-
-
class
cardea.fhir.Account_Coverage(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
-
coverage¶ The party(s) that are responsible for payment (or part of) of charges applied to this account (including self-pay). A coverage may only be resposible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing.
-
priority¶ The priority of the coverage in the context of this account.
-
-
class
cardea.fhir.Account_Guarantor(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA financial tool for tracking value accrued for a particular purpose. In the healthcare field, used to track charges for a patient, cost centers, etc.
-
party¶ The entity who is responsible.
-
onHold¶ A guarantor may be placed on credit hold or otherwise have their role temporarily suspended.
-
period¶ The timeframe during which the guarantor accepts responsibility for the account.
-
-
class
cardea.fhir.ActivityDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
-
resourceType¶ This is a ActivityDefinition resource
-
url¶ An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this activity definition is (or will be) published. The URL SHOULD include the major version of the activity definition. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
-
name¶ A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the activity definition.
-
status¶ The status of this activity definition. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the activity definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.
-
publisher¶ The name of the individual or organization that published the activity definition.
-
description¶ A free text natural language description of the activity definition from a consumer’s perspective.
-
purpose¶ Explaination of why this activity definition is needed and why it has been designed as it has.
-
usage¶ A detailed description of how the asset is used from a clinical perspective.
-
approvalDate¶ The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate¶ The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn’t change the original approval date.
-
effectivePeriod¶ The period during which the activity definition content was or is planned to be in active use.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate activity definition instances.
-
jurisdiction¶ A legal or geographic region in which the activity definition is intended to be used.
-
topic¶ Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
-
contributor¶ A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
copyright¶ A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
Related artifacts such as additional documentation, justification, or bibliographic references.
-
library¶ A reference to a Library resource containing any formal logic used by the asset.
-
kind¶ A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
-
code¶ Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
-
timingTiming¶ The period, timing or frequency upon which the described activity is to occur.
-
timingDateTime¶ The period, timing or frequency upon which the described activity is to occur.
-
timingPeriod¶ The period, timing or frequency upon which the described activity is to occur.
-
timingRange¶ The period, timing or frequency upon which the described activity is to occur.
-
location¶ Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
-
participant¶ Indicates who should participate in performing the action described.
-
productReference¶ Identifies the food, drug or other product being consumed or supplied in the activity.
-
productCodeableConcept¶ Identifies the food, drug or other product being consumed or supplied in the activity.
-
quantity¶ Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).
-
dosage¶ Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
-
bodySite¶ Indicates the sites on the subject’s body where the procedure should be performed (I.e. the target sites).
-
transform¶ A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
-
dynamicValue¶ Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient’s weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the intent resource that would contain the result.
-
-
class
cardea.fhir.ActivityDefinition_Participant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
-
type¶ The type of participant in the action.
-
role¶ The role the participant should play in performing the described action.
-
-
class
cardea.fhir.ActivityDefinition_DynamicValue(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
-
description¶ A brief, natural language description of the intended semantics of the dynamic value.
-
path¶ The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression.
-
language¶ The media type of the language for the expression.
-
expression¶ An expression specifying the value of the customized element.
-
-
class
cardea.fhir.Address(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
-
use¶ The purpose of this address.
-
type¶ Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
-
text¶ A full text representation of the address.
-
line¶ This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
-
city¶ The name of the city, town, village or other community or delivery center.
-
district¶ The name of the administrative area (county).
-
state¶ Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).
-
postalCode¶ A postal code designating a region defined by the postal service.
-
country¶ Country - a nation as commonly understood or generally accepted.
-
period¶ Time period when address was/is in use.
-
-
class
cardea.fhir.AdverseEvent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseActual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.
-
resourceType¶ This is a AdverseEvent resource
-
identifier¶ The identifier(s) of this adverse event that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itsefl is not appropriate.
-
category¶ The type of event which is important to characterize what occurred and caused harm to the subject, or had the potential to cause harm to the subject.
-
type¶ This element defines the specific type of event that occurred or that was prevented from occurring.
-
subject¶ This subject or group impacted by the event. With a prospective adverse event, there will be no subject as the adverse event was prevented.
-
date¶ The date (and perhaps time) when the adverse event occurred.
-
reaction¶ Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical).
-
location¶ The information about where the adverse event occurred.
-
seriousness¶ Describes the seriousness or severity of the adverse event.
-
outcome¶ Describes the type of outcome from the adverse event.
-
recorder¶ Information on who recorded the adverse event. May be the patient or a practitioner.
-
eventParticipant¶ Parties that may or should contribute or have contributed information to the Act. Such information includes information leading to the decision to perform the Act and how to perform the Act (e.g. consultant), information that the Act itself seeks to reveal (e.g. informant of clinical history), or information about what Act was performed (e.g. informant witness).
-
description¶ Describes the adverse event in text.
-
suspectEntity¶ Describes the entity that is suspected to have caused the adverse event.
-
subjectMedicalHistory¶ AdverseEvent.subjectMedicalHistory.
-
referenceDocument¶ AdverseEvent.referenceDocument.
-
study¶ AdverseEvent.study.
-
-
class
cardea.fhir.AdverseEvent_SuspectEntity(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseActual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death.
-
instance¶ Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device.
-
causality¶ causality1 | causality2.
-
causalityAssessment¶ assess1 | assess2.
-
causalityProductRelatedness¶ AdverseEvent.suspectEntity.causalityProductRelatedness.
-
causalityMethod¶ method1 | method2.
-
causalityAuthor¶ AdverseEvent.suspectEntity.causalityAuthor.
-
causalityResult¶ result1 | result2.
-
-
class
cardea.fhir.Age(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA duration of time during which an organism (or a process) has existed.
-
class
cardea.fhir.AllergyIntolerance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRisk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
-
resourceType¶ This is a AllergyIntolerance resource
-
identifier¶ This records identifiers associated with this allergy/intolerance concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
clinicalStatus¶ The clinical status of the allergy or intolerance.
-
verificationStatus¶ Assertion about certainty associated with the propensity, or potential risk, of a reaction to the identified substance (including pharmaceutical product).
-
type¶ Identification of the underlying physiological mechanism for the reaction risk.
-
category¶ Category of the identified substance.
-
criticality¶ Estimate of the potential clinical harm, or seriousness, of the reaction to the identified substance.
-
code¶ Code for an allergy or intolerance statement (either a positive or a negated/excluded statement). This may be a code for a substance or pharmaceutical product that is considered to be responsible for the adverse reaction risk (e.g., “Latex”), an allergy or intolerance condition (e.g., “Latex allergy”), or a negated/excluded code for a specific substance or class (e.g., “No latex allergy”) or a general or categorical negated statement (e.g., “No known allergy”, “No known drug allergies”).
-
patient¶ The patient who has the allergy or intolerance.
-
onsetDateTime¶ Estimated or actual date, date-time, or age when allergy or intolerance was identified.
-
onsetAge¶ Estimated or actual date, date-time, or age when allergy or intolerance was identified.
-
onsetPeriod¶ Estimated or actual date, date-time, or age when allergy or intolerance was identified.
-
onsetRange¶ Estimated or actual date, date-time, or age when allergy or intolerance was identified.
-
onsetString¶ Estimated or actual date, date-time, or age when allergy or intolerance was identified.
-
assertedDate¶ The date on which the existance of the AllergyIntolerance was first asserted or acknowledged.
-
recorder¶ Individual who recorded the record and takes responsibility for its content.
-
asserter¶ The source of the information about the allergy that is recorded.
-
lastOccurrence¶ Represents the date and/or time of the last known occurrence of a reaction event.
-
note¶ Additional narrative about the propensity for the Adverse Reaction, not captured in other fields.
-
reaction¶ Details about each adverse reaction event linked to exposure to the identified substance.
-
-
class
cardea.fhir.AllergyIntolerance_Reaction(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRisk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
-
substance¶ Identification of the specific substance (or pharmaceutical product) considered to be responsible for the Adverse Reaction event. Note: the substance for a specific reaction may be different from the substance identified as the cause of the risk, but it must be consistent with it. For instance, it may be a more specific substance (e.g. a brand medication) or a composite product that includes the identified substance. It must be clinically safe to only process the ‘code’ and ignore the ‘reaction.substance’.
-
manifestation¶ Clinical symptoms and/or signs that are observed or associated with the adverse reaction event.
-
description¶ Text description about the reaction as a whole, including details of the manifestation if required.
-
onset¶ Record of the date and/or time of the onset of the Reaction.
-
severity¶ Clinical assessment of the severity of the reaction event as a whole, potentially considering multiple different manifestations.
-
exposureRoute¶ Identification of the route by which the subject was exposed to the substance.
-
note¶ Additional text about the adverse reaction event not captured in other fields.
-
-
class
cardea.fhir.Annotation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA text note which also contains information about who made the statement and when.
The individual responsible for making the annotation.
The individual responsible for making the annotation.
-
time¶ Indicates when this particular annotation was made.
-
text¶ The text of the annotation.
-
class
cardea.fhir.Appointment(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
-
resourceType¶ This is a Appointment resource
-
identifier¶ This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
status¶ The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.
-
serviceCategory¶ A broad categorisation of the service that is to be performed during this appointment.
-
serviceType¶ The specific service that is to be performed during this appointment.
-
specialty¶ The specialty of a practitioner that would be required to perform the service requested in this appointment.
-
appointmentType¶ The style of appointment or patient that has been booked in the slot (not service type).
-
reason¶ The reason that this appointment is being scheduled. This is more clinical than administrative.
-
indication¶ Reason the appointment has been scheduled to take place, as specified using information from another resource. When the patient arrives and the encounter begins it may be used as the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
-
priority¶ The priority of the appointment. Can be used to make informed decisions if needing to re-prioritize appointments. (The iCal Standard specifies 0 as undefined, 1 as highest, 9 as lowest priority).
-
description¶ The brief description of the appointment as would be shown on a subject line in a meeting request, or appointment list. Detailed or expanded information should be put in the comment field.
-
supportingInformation¶ Additional information to support the appointment provided when making the appointment.
-
start¶ Date/Time that the appointment is to take place.
-
end¶ Date/Time that the appointment is to conclude.
-
minutesDuration¶ Number of minutes that the appointment is to take. This can be less than the duration between the start and end times (where actual time of appointment is only an estimate or is a planned appointment request).
-
slot¶ The slots from the participants’ schedules that will be filled by the appointment.
-
created¶ The date that this appointment was initially created. This could be different to the meta.lastModified value on the initial entry, as this could have been before the resource was created on the FHIR server, and should remain unchanged over the lifespan of the appointment.
-
comment¶ Additional comments about the appointment.
-
incomingReferral¶ The referral request this appointment is allocated to assess (incoming referral).
-
participant¶ List of participants involved in the appointment.
-
requestedPeriod¶ A set of date ranges (potentially including times) that the appointment is preferred to be scheduled within. When using these values, the minutes duration should be provided to indicate the length of the appointment to fill and populate the start/end times for the actual allocated time.
-
-
class
cardea.fhir.Appointment_Participant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).
-
type¶ Role of participant in the appointment.
-
actor¶ A Person, Location/HealthcareService or Device that is participating in the appointment.
-
required¶ Is this participant required to be present at the meeting. This covers a use-case where 2 doctors need to meet to discuss the results for a specific patient, and the patient is not required to be present.
-
status¶ Participation status of the actor.
-
-
class
cardea.fhir.AppointmentResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection.
-
resourceType¶ This is a AppointmentResponse resource
-
identifier¶ This records identifiers associated with this appointment response concern that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate.
-
appointment¶ Appointment that this response is replying to.
-
start¶ Date/Time that the appointment is to take place, or requested new start time.
-
end¶ This may be either the same as the appointment request to confirm the details of the appointment, or alternately a new time to request a re-negotiation of the end time.
-
participantType¶ Role of participant in the appointment.
-
actor¶ A Person, Location/HealthcareService or Device that is participating in the appointment.
-
participantStatus¶ Participation status of the participant. When the status is declined or tentative if the start/end times are different to the appointment, then these times should be interpreted as a requested time change. When the status is accepted, the times can either be the time of the appointment (as a confirmation of the time) or can be empty.
-
comment¶ Additional comments about the appointment.
-
-
class
cardea.fhir.Attachment(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseFor referring to data content defined in other formats.
-
contentType¶ Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
-
language¶ The human language of the content. The value can be any valid value according to BCP 47.
-
data¶ The actual data of the attachment - a sequence of bytes. In XML, represented using base64.
-
url¶ An alternative location where the data can be accessed.
-
size¶ The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
-
hash¶ The calculated hash of the data using SHA-1. Represented using base64.
-
title¶ A label or set of text to display in place of the data.
-
creation¶ The date that the attachment was first created.
-
-
class
cardea.fhir.AuditEvent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
-
resourceType¶ This is a AuditEvent resource
-
type¶ Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.
-
subtype¶ Identifier for the category of event.
-
action¶ Indicator for type of action performed during the event that generated the audit.
-
recorded¶ The time when the event occurred on the source.
-
outcome¶ Indicates whether the event succeeded or failed.
-
outcomeDesc¶ A free text description of the outcome of the event.
-
purposeOfEvent¶ The purposeOfUse (reason) that was used during the event being recorded.
-
agent¶ An actor taking an active role in the event or activity that is logged.
-
source¶ The system that is reporting the event.
-
entity¶ Specific instances of data or objects that have been accessed.
-
-
class
cardea.fhir.AuditEvent_Agent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
-
role¶ The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.
-
reference¶ Direct reference to a resource that identifies the agent.
-
userId¶ Unique identifier for the user actively participating in the event.
-
altId¶ Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.
-
name¶ Human-meaningful name for the agent.
-
requestor¶ Indicator that the user is or is not the requestor, or initiator, for the event being audited.
-
location¶ Where the event occurred.
-
policy¶ The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.
-
media¶ Type of media involved. Used when the event is about exporting/importing onto media.
-
network¶ Logical network location for application activity, if the activity has a network location.
-
purposeOfUse¶ The reason (purpose of use), specific to this agent, that was used during the event being recorded.
-
-
class
cardea.fhir.AuditEvent_Network(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
-
address¶ An identifier for the network access point of the user device for the audit event.
-
type¶ An identifier for the type of network access point that originated the audit event.
-
-
class
cardea.fhir.AuditEvent_Source(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
-
site¶ Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.
-
identifier¶ Identifier of the source where the event was detected.
-
type¶ Code specifying the type of source where event originated.
-
-
class
cardea.fhir.AuditEvent_Entity(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
-
identifier¶ Identifies a specific instance of the entity. The reference should always be version specific.
-
reference¶ Identifies a specific instance of the entity. The reference should be version specific.
-
type¶ The type of the object that was involved in this audit event.
-
role¶ Code representing the role the entity played in the event being audited.
-
lifecycle¶ Identifier for the data life-cycle stage for the entity.
-
securityLabel¶ Security labels for the identified entity.
-
name¶ A name of the entity in the audit event.
-
description¶ Text that describes the entity in more detail.
-
query¶ The query parameters for a query-type entities.
-
detail¶ Tagged value pairs for conveying additional information about the entity.
-
-
class
cardea.fhir.AuditEvent_Detail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
-
type¶ The type of extra detail provided in the value.
-
value¶ The details, base64 encoded. Used to carry bulk information.
-
-
class
cardea.fhir.BackboneElement(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseBase definition for all elements that are defined inside a resource - but not those in a data type.
-
modifierExtension¶ May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
-
-
class
cardea.fhir.Basic(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseBasic is used for handling concepts not yet defined in FHIR, narrative-only resources that don’t map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
-
resourceType¶ This is a Basic resource
-
identifier¶ Identifier assigned to the resource for business purposes, outside the context of FHIR.
-
code¶ Identifies the ‘type’ of resource - equivalent to the resource name for other resources.
-
subject¶ Identifies the patient, practitioner, device or any other resource that is the “focus” of this resource.
-
created¶ Identifies when the resource was first created.
Indicates who was responsible for creating the resource instance.
-
-
class
cardea.fhir.Binary(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA binary resource can contain any content, whether text, image, pdf, zip archive, etc.
-
resourceType¶ This is a Binary resource
-
contentType¶ MimeType of the binary content represented as a standard MimeType (BCP 13).
-
securityContext¶ Treat this binary as if it was this other resource for access control purposes.
-
content¶ The actual content, base64 encoded.
-
-
class
cardea.fhir.BodySite(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRecord details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.
-
resourceType¶ This is a BodySite resource
-
identifier¶ Identifier for this instance of the anatomical location.
-
active¶ Whether this body site is in active use.
-
code¶ Named anatomical location - ideally coded where possible.
-
qualifier¶ Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.
-
description¶ A summary, charactarization or explanation of the anatomic location.
-
image¶ Image or images used to identify a location.
-
patient¶ The person to which the body site belongs.
-
-
class
cardea.fhir.Bundle(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA container for a collection of resources.
-
resourceType¶ This is a Bundle resource
-
identifier¶ A persistent identifier for the batch that won’t change as a batch is copied from server to server.
-
type¶ Indicates the purpose of this bundle - how it was intended to be used.
-
total¶ If a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle).
-
link¶ A series of links that provide context to this bundle.
-
entry¶ An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only).
-
signature¶ Digital Signature - base64 encoded. XML-DSIg or a JWT.
-
-
class
cardea.fhir.Bundle_Link(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA container for a collection of resources.
-
relation¶ A name which details the functional use for this link - see [http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1](http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1).
-
url¶ The reference details for the link.
-
-
class
cardea.fhir.Bundle_Entry(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA container for a collection of resources.
-
link¶ A series of links that provide context to this entry.
-
fullUrl¶ The Absolute URL for the resource. The fullUrl SHALL not disagree with the id in the resource. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that: * fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle) * Results from operations might involve resources that are not identified.
-
resource¶ The Resources for the entry.
-
search¶ Information about the search process that lead to the creation of this entry.
-
request¶ Additional information about how this entry should be processed as part of a transaction.
-
response¶ Additional information about how this entry should be processed as part of a transaction.
-
-
class
cardea.fhir.Bundle_Search(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA container for a collection of resources.
-
mode¶ Why this entry is in the result set - whether it’s included as a match or because of an _include requirement.
-
score¶ When searching, the server’s search ranking score for the entry.
-
-
class
cardea.fhir.Bundle_Request(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA container for a collection of resources.
-
method¶ The HTTP verb for this entry in either a change history, or a transaction/ transaction response.
-
url¶ The URL for this entry, relative to the root (the address to which the request is posted).
-
ifNoneMatch¶ If the ETag values match, return a 304 Not Modified status. See the API documentation for [“Conditional Read”](http.html#cread).
-
ifModifiedSince¶ Only perform the operation if the last updated date matches. See the API documentation for [“Conditional Read”](http.html#cread).
-
ifMatch¶ Only perform the operation if the Etag value matches. For more information, see the API section [“Managing Resource Contention”](http.html#concurrency).
-
ifNoneExist¶ Instruct the server not to perform the create if a specified resource already exists. For further information, see the API documentation for [“Conditional Create”](http.html#ccreate). This is just the query portion of the URL - what follows the “?” (not including the “?”).
-
-
class
cardea.fhir.Bundle_Response(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA container for a collection of resources.
-
status¶ The status code returned by processing this entry. The status SHALL start with a 3 digit HTTP code (e.g. 404) and may contain the standard HTTP description associated with the status code.
-
location¶ The location header created by processing this operation.
-
etag¶ The etag for the resource, it the operation for the entry produced a versioned resource (see [Resource Metadata and Versioning](http.html#versioning) and [Managing Resource Contention](http.html#concurrency)).
-
lastModified¶ The date/time that the resource was modified on the server.
-
outcome¶ An OperationOutcome containing hints and warnings produced as part of processing this entry in a batch or transaction.
-
-
class
cardea.fhir.CapabilityStatement(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
resourceType¶ This is a CapabilityStatement resource
-
url¶ An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see [Technical and Business Versions](resource.html#versions).
-
version¶ The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the capability statement.
-
status¶ The status of this capability statement. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the capability statement was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.
-
publisher¶ The name of the individual or organization that published the capability statement.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the capability statement from a consumer’s perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate capability statement instances.
-
jurisdiction¶ A legal or geographic region in which the capability statement is intended to be used.
-
purpose¶ Explaination of why this capability statement is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.
-
kind¶ The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind not instance of software) or a class of implementation (e.g. a desired purchase).
-
instantiates¶ Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do so.
-
software¶ Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
-
implementation¶ Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
-
fhirVersion¶ The version of the FHIR specification on which this capability statement is based.
-
acceptUnknown¶ A code that indicates whether the application accepts unknown elements or extensions when reading resources.
-
format¶ A list of the formats supported by this implementation using their content types.
-
patchFormat¶ A list of the patch formats supported by this implementation using their content types.
-
implementationGuide¶ A list of implementation guides that the server does (or should) support in their entirety.
-
profile¶ A list of profiles that represent different use cases supported by the system. For a server, “supported by the system” means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).
-
rest¶ A definition of the restful capabilities of the solution, if any.
-
messaging¶ A description of the messaging capabilities of the solution.
-
document¶ A document definition.
-
-
class
cardea.fhir.CapabilityStatement_Software(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
name¶ Name software is known by.
-
version¶ The version identifier for the software covered by this statement.
-
releaseDate¶ Date this version of the software was released.
-
-
class
cardea.fhir.CapabilityStatement_Implementation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
description¶ Information about the specific installation that this capability statement relates to.
-
url¶ An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.
-
-
class
cardea.fhir.CapabilityStatement_Rest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
mode¶ Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.
-
documentation¶ Information about the system’s restful capabilities that apply across all applications, such as security.
-
security¶ Information about security implementation from an interface perspective - what a client needs to know.
-
resource¶ A specification of the restful capabilities of the solution for a specific resource type.
-
interaction¶ A specification of restful operations supported by the system.
-
searchParam¶ Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
-
operation¶ Definition of an operation or a named query together with its parameters and their meaning and type.
-
compartment¶ An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .
-
-
class
cardea.fhir.CapabilityStatement_Security(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
cors¶ Server adds CORS headers when responding to requests - this enables javascript applications to use the server.
-
service¶ Types of security services that are supported/required by the system.
-
description¶ General description of how security works.
-
certificate¶ Certificates associated with security profiles.
-
-
class
cardea.fhir.CapabilityStatement_Certificate(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
type¶ Mime type for a certificate.
-
blob¶ Actual certificate.
-
-
class
cardea.fhir.CapabilityStatement_Resource(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
type¶ A type of resource exposed via the restful interface.
-
profile¶ A specification of the profile that describes the solution’s overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses).
-
documentation¶ Additional information about the resource type used by the system.
-
interaction¶ Identifies a restful operation supported by the solution.
-
versioning¶ This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is ‘versioned-update’, then the server supports all the versioning features, including using e-tags for version integrity in the API.
-
readHistory¶ A flag for whether the server is able to return past versions as part of the vRead operation.
-
updateCreate¶ A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.
-
conditionalCreate¶ A flag that indicates that the server supports conditional create.
-
conditionalRead¶ A code that indicates how the server supports conditional read.
-
conditionalUpdate¶ A flag that indicates that the server supports conditional update.
-
conditionalDelete¶ A code that indicates how the server supports conditional delete.
-
referencePolicy¶ A set of flags that defines how references are supported.
-
searchInclude¶ A list of _include values supported by the server.
-
searchRevInclude¶ A list of _revinclude (reverse include) values supported by the server.
-
searchParam¶ Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
-
-
class
cardea.fhir.CapabilityStatement_Interaction(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
code¶ Coded identifier of the operation, supported by the system resource.
-
documentation¶ Guidance specific to the implementation of this operation, such as ‘delete is a logical delete’ or ‘updates are only allowed with version id’ or ‘creates permitted from pre-authorized certificates only’.
-
-
class
cardea.fhir.CapabilityStatement_SearchParam(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
name¶ The name of the search parameter used in the interface.
-
definition¶ An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]).
-
type¶ The type of value a search parameter refers to, and how the content is interpreted.
-
documentation¶ This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.
-
-
class
cardea.fhir.CapabilityStatement_Interaction1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
code¶ A coded identifier of the operation, supported by the system.
-
documentation¶ Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.
-
-
class
cardea.fhir.CapabilityStatement_Operation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
name¶ The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.
-
definition¶ Where the formal definition can be found.
-
-
class
cardea.fhir.CapabilityStatement_Messaging(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
endpoint¶ An endpoint (network accessible address) to which messages and/or replies are to be sent.
-
reliableCache¶ Length if the receiver’s reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).
-
documentation¶ Documentation about the system’s messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.
-
supportedMessage¶ References to message definitions for messages this system can send or receive.
-
event¶ A description of the solution’s support for an event at this end-point.
-
-
class
cardea.fhir.CapabilityStatement_Endpoint(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
protocol¶ A list of the messaging transport protocol(s) identifiers, supported by this endpoint.
-
address¶ The network address of the end-point. For solutions that do not use network addresses for routing, it can be just an identifier.
-
-
class
cardea.fhir.CapabilityStatement_SupportedMessage(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
mode¶ The mode of this event declaration - whether application is sender or receiver.
-
definition¶ Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.
-
-
class
cardea.fhir.CapabilityStatement_Event(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
code¶ A coded identifier of a supported messaging event.
-
category¶ The impact of the content of the message.
-
mode¶ The mode of this event declaration - whether an application is a sender or receiver.
-
focus¶ A resource associated with the event. This is the resource that defines the event.
-
request¶ Information about the request for this event.
-
response¶ Information about the response for this event.
-
documentation¶ Guidance on how this event is handled, such as internal system trigger points, business rules, etc.
-
-
class
cardea.fhir.CapabilityStatement_Document(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
-
mode¶ Mode of this document declaration - whether an application is a producer or consumer.
-
documentation¶ A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc.
-
profile¶ A constraint on a resource used in the document.
-
-
class
cardea.fhir.CarePlan(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
-
resourceType¶ This is a CarePlan resource
-
identifier¶ This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
definition¶ Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.
-
basedOn¶ A care plan that is fulfilled in whole or in part by this care plan.
-
replaces¶ Completed or terminated care plan whose function is taken by this new care plan.
-
partOf¶ A larger care plan of which this particular care plan is a component or step.
-
status¶ Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
-
intent¶ Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
-
category¶ Identifies what “kind” of plan this is to support differentiation between multiple co-existing plans; e.g. “Home health”, “psychiatric”, “asthma”, “disease management”, “wellness plan”, etc.
-
title¶ Human-friendly name for the CarePlan.
-
description¶ A description of the scope and nature of the plan.
-
subject¶ Identifies the patient or group whose intended care is described by the plan.
-
context¶ Identifies the original context in which this particular CarePlan was created.
-
period¶ Indicates when the plan did (or is intended to) come into effect and end.
Identifies the individual(s) or ogranization who is responsible for the content of the care plan.
-
careTeam¶ Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
-
addresses¶ Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
-
supportingInfo¶ Identifies portions of the patient’s record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.
-
goal¶ Describes the intended objective(s) of carrying out the care plan.
-
activity¶ Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
-
note¶ General notes about the care plan not covered elsewhere.
-
-
class
cardea.fhir.CarePlan_Activity(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
-
outcomeCodeableConcept¶ Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).
-
outcomeReference¶ Details of the outcome or action resulting from the activity. The reference to an “event” resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).
-
progress¶ Notes about the adherence/status/progress of the activity.
-
reference¶ The details of the proposed activity represented in a specific resource.
-
detail¶ A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn’t know about specific resources such as procedure etc.
-
-
class
cardea.fhir.CarePlan_Detail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
-
category¶ High-level categorization of the type of activity in a care plan.
-
definition¶ Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.
-
code¶ Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.
-
reasonCode¶ Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.
-
reasonReference¶ Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.
-
goal¶ Internal reference that identifies the goals that this activity is intended to contribute towards meeting.
-
status¶ Identifies what progress is being made for the specific activity.
-
statusReason¶ Provides reason why the activity isn’t yet started, is on hold, was cancelled, etc.
-
prohibited¶ If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, indicates that the described activity is one that should be engaged in when following the plan.
-
scheduledTiming¶ The period, timing or frequency upon which the described activity is to occur.
-
scheduledPeriod¶ The period, timing or frequency upon which the described activity is to occur.
-
scheduledString¶ The period, timing or frequency upon which the described activity is to occur.
-
location¶ Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
-
performer¶ Identifies who’s expected to be involved in the activity.
-
productCodeableConcept¶ Identifies the food, drug or other product to be consumed or supplied in the activity.
-
productReference¶ Identifies the food, drug or other product to be consumed or supplied in the activity.
-
dailyAmount¶ Identifies the quantity expected to be consumed in a given day.
-
quantity¶ Identifies the quantity expected to be supplied, administered or consumed by the subject.
-
description¶ This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.
-
-
class
cardea.fhir.CareTeam(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
-
resourceType¶ This is a CareTeam resource
-
identifier¶ This records identifiers associated with this care team that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.
-
status¶ Indicates the current state of the care team.
-
category¶ Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.
-
name¶ A label for human use intended to distinguish like teams. E.g. the “red” vs. “green” trauma teams.
-
subject¶ Identifies the patient or group whose intended care is handled by the team.
-
context¶ The encounter or episode of care that establishes the context for this care team.
-
period¶ Indicates when the team did (or is intended to) come into effect and end.
-
participant¶ Identifies all people and organizations who are expected to be involved in the care team.
-
reasonCode¶ Describes why the care team exists.
-
reasonReference¶ Condition(s) that this care team addresses.
-
managingOrganization¶ The organization responsible for the care team.
-
note¶ Comments made about the CareTeam.
-
-
class
cardea.fhir.CareTeam_Participant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
-
role¶ Indicates specific responsibility of an individual within the care team, such as “Primary care physician”, “Trained social worker counselor”, “Caregiver”, etc.
-
member¶ The specific person or organization who is participating/expected to participate in the care team.
-
onBehalfOf¶ The organization of the practitioner.
-
period¶ Indicates when the specific member or organization did (or is intended to) come into effect and end.
-
-
class
cardea.fhir.ChargeItem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.
-
resourceType¶ This is a ChargeItem resource
-
identifier¶ Identifiers assigned to this event performer or other systems.
-
definition¶ References the source of pricing information, rules of application for the code this ChargeItem uses.
-
status¶ The current state of the ChargeItem.
-
partOf¶ ChargeItems can be grouped to larger ChargeItems covering the whole set.
-
code¶ A code that identifies the charge, like a billing code.
-
subject¶ The individual or set of individuals the action is being or was performed on.
-
context¶ The encounter or episode of care that establishes the context for this event.
-
occurrenceDateTime¶ Date/time(s) or duration when the charged service was applied.
-
occurrencePeriod¶ Date/time(s) or duration when the charged service was applied.
-
occurrenceTiming¶ Date/time(s) or duration when the charged service was applied.
-
participant¶ Indicates who or what performed or participated in the charged service.
-
performingOrganization¶ The organization requesting the service.
-
requestingOrganization¶ The organization performing the service.
-
quantity¶ Quantity of which the charge item has been serviced.
-
bodysite¶ The anatomical location where the related service has been applied.
-
factorOverride¶ Factor overriding the factor determined by the rules associated with the code.
-
priceOverride¶ Total price of the charge overriding the list price associated with the code.
-
overrideReason¶ If the list price or the rule based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.
-
enterer¶ The device, practitioner, etc. who entered the charge item.
-
enteredDate¶ Date the charge item was entered.
-
reason¶ Describes why the event occurred in coded or textual form.
-
service¶ Indicated the rendered service that caused this charge.
-
account¶ Account into which this ChargeItems belongs.
-
note¶ Comments made about the event by the performer, subject or other participants.
-
supportingInformation¶ Further information supporting the this charge.
-
-
class
cardea.fhir.ChargeItem_Participant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.
-
role¶ Describes the type of performance or participation(e.g. primary surgeon, anaesthesiologiest, etc.).
-
actor¶ The device, practitioner, etc. who performed or participated in the service.
-
-
class
cardea.fhir.Claim(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
resourceType¶ This is a Claim resource
-
identifier¶ The business identifier for the instance: claim number, pre-determination or pre-authorization number.
-
status¶ The status of the resource instance.
-
type¶ The category of claim, eg, oral, pharmacy, vision, insitutional, professional.
-
subType¶ A finer grained suite of claim subtype codes which may convey Inpatient vs Outpatient and/or a specialty service. In the US the BillType.
-
use¶ Complete (Bill or Claim), Proposed (Pre-Authorization), Exploratory (Pre-determination).
-
patient¶ Patient Resource.
-
billablePeriod¶ The billable period for which charges are being submitted.
-
created¶ The date when the enclosed suite of services were performed or completed.
-
enterer¶ Person who created the invoice/claim/pre-determination or pre-authorization.
-
insurer¶ The Insurer who is target of the request.
-
provider¶ The provider which is responsible for the bill, claim pre-determination, pre-authorization.
-
organization¶ The organization which is responsible for the bill, claim pre-determination, pre-authorization.
-
priority¶ Immediate (STAT), best effort (NORMAL), deferred (DEFER).
-
fundsReserve¶ In the case of a Pre-Determination/Pre-Authorization the provider may request that funds in the amount of the expected Benefit be reserved (‘Patient’ or ‘Provider’) to pay for the Benefits determined on the subsequent claim(s). ‘None’ explicitly indicates no funds reserving is requested.
Other claims which are related to this claim such as prior claim versions or for related services.
-
prescription¶ Prescription to support the dispensing of Pharmacy or Vision products.
-
originalPrescription¶ Original prescription which has been superceded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new precription for an alternate medication which has the same theraputic intent. The prescription from the pharmacy becomes the ‘prescription’ and that from the physician becomes the ‘original prescription’.
-
payee¶ The party to be reimbursed for the services.
-
referral¶ The referral resource which lists the date, practitioner, reason and other supporting information.
-
facility¶ Facility where the services were provided.
-
careTeam¶ The members of the team who provided the overall service as well as their role and whether responsible and qualifications.
-
information¶ Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are mutiple jurisdiction specific valuesets which are required.
-
diagnosis¶ List of patient diagnosis for which care is sought.
-
procedure¶ Ordered list of patient procedures performed to support the adjudication.
-
insurance¶ Financial instrument by which payment information for health care.
-
accident¶ An accident which resulted in the need for healthcare services.
-
employmentImpacted¶ The start and optional end dates of when the patient was precluded from working due to the treatable condition(s).
-
hospitalization¶ The start and optional end dates of when the patient was confined to a treatment center.
-
item¶ First tier of goods and services.
-
total¶ The total value of the claim.
-
-
class
cardea.fhir.Claim_Related(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
claim¶ Other claims which are related to this claim such as prior claim versions or for related services.
-
relationship¶ For example prior or umbrella.
-
reference¶ An alternate organizational reference to the case or file to which this particular claim pertains - eg Property/Casualy insurer claim # or Workers Compensation case # .
-
-
class
cardea.fhir.Claim_Payee(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
type¶ Type of Party to be reimbursed: Subscriber, provider, other.
-
resourceType¶ organization | patient | practitioner | relatedperson.
-
party¶ Party to be reimbursed: Subscriber, provider, other.
-
-
class
cardea.fhir.Claim_CareTeam(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ Sequence of the careTeam which serves to order and provide a link.
-
provider¶ Member of the team who provided the overall service.
-
responsible¶ The party who is billing and responsible for the claimed good or service rendered to the patient.
-
role¶ The lead, assisting or supervising practitioner and their discipline if a multidisiplinary team.
-
qualification¶ The qualification which is applicable for this service.
-
-
class
cardea.fhir.Claim_Information(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ Sequence of the information element which serves to provide a link.
-
category¶ The general class of the information supplied: information; exception; accident, employment; onset, etc.
-
code¶ System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought which may influence the adjudication.
-
timingDate¶ The date when or period to which this information refers.
-
timingPeriod¶ The date when or period to which this information refers.
-
valueString¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
valueQuantity¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
valueAttachment¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
valueReference¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
reason¶ For example, provides the reason for: the additional stay, or missing tooth or any other situation where a reason code is required in addition to the content.
-
-
class
cardea.fhir.Claim_Diagnosis(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ Sequence of diagnosis which serves to provide a link.
-
diagnosisCodeableConcept¶ The diagnosis.
-
diagnosisReference¶ The diagnosis.
-
type¶ The type of the Diagnosis, for example: admitting, primary, secondary, discharge.
-
packageCode¶ The package billing code, for example DRG, based on the assigned grouping code system.
-
-
class
cardea.fhir.Claim_Procedure(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ Sequence of procedures which serves to order and provide a link.
-
date¶ Date and optionally time the procedure was performed .
-
procedureCodeableConcept¶ The procedure code.
-
procedureReference¶ The procedure code.
-
-
class
cardea.fhir.Claim_Insurance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ Sequence of coverage which serves to provide a link and convey coordination of benefit order.
-
focal¶ A flag to indicate that this Coverage is the focus for adjudication. The Coverage against which the claim is to be adjudicated.
-
coverage¶ Reference to the program or plan identification, underwriter or payor.
-
businessArrangement¶ The contract number of a business agreement which describes the terms and conditions.
-
preAuthRef¶ A list of references from the Insurer to which these services pertain.
-
claimResponse¶ The Coverages adjudication details.
-
-
class
cardea.fhir.Claim_Accident(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
date¶ Date of an accident which these services are addressing.
-
type¶ Type of accident: work, auto, etc.
-
locationAddress¶ Accident Place.
-
locationReference¶ Accident Place.
-
-
class
cardea.fhir.Claim_Item(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ A service line number.
-
careTeamLinkId¶ CareTeam applicable for this service or product line.
-
diagnosisLinkId¶ Diagnosis applicable for this service or product line.
-
procedureLinkId¶ Procedures applicable for this service or product line.
-
informationLinkId¶ Exceptions, special conditions and supporting information pplicable for this service or product line.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,RXNorm,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. ‘glasses’ or ‘compound’.
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
programCode¶ For programs which require reason codes for the inclusion or covering of this billed item under the program or sub-program.
-
servicedDate¶ The date or dates when the enclosed suite of services were performed or completed.
-
servicedPeriod¶ The date or dates when the enclosed suite of services were performed or completed.
-
locationCodeableConcept¶ Where the service was provided.
-
locationAddress¶ Where the service was provided.
-
locationReference¶ Where the service was provided.
-
quantity¶ The number of repetitions of a service or product.
-
unitPrice¶ If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.
-
factor¶ A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
net¶ The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
udi¶ List of Unique Device Identifiers associated with this line item.
-
bodySite¶ Physical service site on the patient (limb, tooth, etc).
-
subSite¶ A region or surface of the site, eg. limb region or tooth surface(s).
-
encounter¶ A billed item may include goods or services provided in multiple encounters.
-
detail¶ Second tier of goods and services.
-
-
class
cardea.fhir.Claim_Detail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ A service line number.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. ‘glasses’ or ‘compound’.
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
programCode¶ For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.
-
quantity¶ The number of repetitions of a service or product.
-
unitPrice¶ If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.
-
factor¶ A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
net¶ The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
udi¶ List of Unique Device Identifiers associated with this line item.
-
subDetail¶ Third tier of goods and services.
-
-
class
cardea.fhir.Claim_SubDetail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery.
-
sequence¶ A service line number.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI).
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
programCode¶ For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.
-
quantity¶ The number of repetitions of a service or product.
-
unitPrice¶ The fee for an addittional service or product or charge.
-
factor¶ A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
net¶ The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
udi¶ List of Unique Device Identifiers associated with this line item.
-
-
class
cardea.fhir.ClaimResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
resourceType¶ This is a ClaimResponse resource
-
identifier¶ The Response business identifier.
-
status¶ The status of the resource instance.
-
patient¶ Patient Resource.
-
created¶ The date when the enclosed suite of services were performed or completed.
-
insurer¶ The Insurer who produced this adjudicated response.
-
requestProvider¶ The practitioner who is responsible for the services rendered to the patient.
-
requestOrganization¶ The organization which is responsible for the services rendered to the patient.
-
request¶ Original request resource referrence.
-
outcome¶ Processing outcome errror, partial or complete processing.
-
disposition¶ A description of the status of the adjudication.
-
payeeType¶ Party to be reimbursed: Subscriber, provider, other.
-
item¶ The first tier service adjudications for submitted services.
-
addItem¶ The first tier service adjudications for payor added services.
-
error¶ Mutually exclusive with Services Provided (Item).
-
totalCost¶ The total cost of the services reported.
-
unallocDeductable¶ The amount of deductible applied which was not allocated to any particular service line.
-
totalBenefit¶ Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductible).
-
payment¶ Payment details for the claim if the claim has been paid.
-
reserved¶ Status of funds reservation (For provider, for Patient, None).
-
form¶ The form to be used for printing the content.
-
processNote¶ Note text.
-
communicationRequest¶ Request for additional supporting or authorizing information, such as: documents, images or resources.
-
insurance¶ Financial instrument by which payment information for health care.
-
-
class
cardea.fhir.ClaimResponse_Item(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
sequenceLinkId¶ A service line number.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudication results.
-
detail¶ The second tier service adjudications for submitted services.
-
-
class
cardea.fhir.ClaimResponse_Adjudication(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
category¶ Code indicating: Co-Pay, deductible, eligible, benefit, tax, etc.
-
reason¶ Adjudication reason such as limit reached.
-
amount¶ Monetary amount associated with the code.
-
value¶ A non-monetary value for example a percentage. Mutually exclusive to the amount element above.
-
-
class
cardea.fhir.ClaimResponse_Detail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
sequenceLinkId¶ A service line number.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
subDetail¶ The third tier service adjudications for submitted services.
-
-
class
cardea.fhir.ClaimResponse_SubDetail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
sequenceLinkId¶ A service line number.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
-
class
cardea.fhir.ClaimResponse_AddItem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
sequenceLinkId¶ List of input service items which this service line is intended to replace.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ A code to indicate the Professional Service or Product supplied.
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
fee¶ The fee charged for the professional service or product..
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
detail¶ The second tier service adjudications for payor added services.
-
-
class
cardea.fhir.ClaimResponse_Detail1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ A code to indicate the Professional Service or Product supplied.
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
fee¶ The fee charged for the professional service or product..
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
-
class
cardea.fhir.ClaimResponse_Error(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
sequenceLinkId¶ The sequence number of the line item submitted which contains the error. This value is omitted when the error is elsewhere.
-
detailSequenceLinkId¶ The sequence number of the addition within the line item submitted which contains the error. This value is omitted when the error is not related to an Addition.
-
subdetailSequenceLinkId¶ The sequence number of the addition within the line item submitted which contains the error. This value is omitted when the error is not related to an Addition.
-
code¶ An error code,from a specified code system, which details why the claim could not be adjudicated.
-
-
class
cardea.fhir.ClaimResponse_Payment(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
type¶ Whether this represents partial or complete payment of the claim.
-
adjustment¶ Adjustment to the payment of this transaction which is not related to adjudication of this transaction.
-
adjustmentReason¶ Reason for the payment adjustment.
-
date¶ Estimated payment data.
-
amount¶ Payable less any payment adjustment.
-
identifier¶ Payment identifier.
-
-
class
cardea.fhir.ClaimResponse_ProcessNote(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
number¶ An integer associated with each note which may be referred to from each service line item.
-
type¶ The note purpose: Print/Display.
-
text¶ The note text.
-
language¶ The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. “en” for English, or “en-US” for American English versus “en-EN” for England English.
-
-
class
cardea.fhir.ClaimResponse_Insurance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the adjudication details from the processing of a Claim resource.
-
sequence¶ A service line item.
-
focal¶ The instance number of the Coverage which is the focus for adjudication. The Coverage against which the claim is to be adjudicated.
-
coverage¶ Reference to the program or plan identification, underwriter or payor.
-
businessArrangement¶ The contract number of a business agreement which describes the terms and conditions.
-
preAuthRef¶ A list of references from the Insurer to which these services pertain.
-
claimResponse¶ The Coverages adjudication details.
-
-
class
cardea.fhir.ClinicalImpression(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient’s condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called “ClinicalImpression” rather than “ClinicalAssessment” to avoid confusion with the recording of assessment tools such as Apgar score.
-
resourceType¶ This is a ClinicalImpression resource
-
identifier¶ A unique identifier assigned to the clinical impression that remains consistent regardless of what server the impression is stored on.
-
status¶ Identifies the workflow status of the assessment.
-
code¶ Categorizes the type of clinical assessment performed.
-
description¶ A summary of the context and/or cause of the assessment - why / where was it performed, and what patient events/status prompted it.
-
subject¶ The patient or group of individuals assessed as part of this record.
-
context¶ The encounter or episode of care this impression was created as part of.
-
effectiveDateTime¶ The point in time or period over which the subject was assessed.
-
effectivePeriod¶ The point in time or period over which the subject was assessed.
-
date¶ Indicates when the documentation of the assessment was complete.
-
assessor¶ The clinician performing the assessment.
-
previous¶ A reference to the last assesment that was conducted bon this patient. Assessments are often/usually ongoing in nature; a care provider (practitioner or team) will make new assessments on an ongoing basis as new data arises or the patient’s conditions changes.
-
problem¶ This a list of the relevant problems/conditions for a patient.
-
investigation¶ One or more sets of investigations (signs, symptions, etc.). The actual grouping of investigations vary greatly depending on the type and context of the assessment. These investigations may include data generated during the assessment process, or data previously generated and recorded that is pertinent to the outcomes.
-
protocol¶ Reference to a specific published clinical protocol that was followed during this assessment, and/or that provides evidence in support of the diagnosis.
-
summary¶ A text summary of the investigations and the diagnosis.
-
finding¶ Specific findings or diagnoses that was considered likely or relevant to ongoing treatment.
-
prognosisCodeableConcept¶ Estimate of likely outcome.
-
prognosisReference¶ RiskAssessment expressing likely outcome.
-
action¶ Action taken as part of assessment procedure.
-
note¶ Commentary about the impression, typically recorded after the impression itself was made, though supplemental notes by the original author could also appear.
-
-
class
cardea.fhir.ClinicalImpression_Investigation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient’s condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called “ClinicalImpression” rather than “ClinicalAssessment” to avoid confusion with the recording of assessment tools such as Apgar score.
-
code¶ A name/code for the group (“set”) of investigations. Typically, this will be something like “signs”, “symptoms”, “clinical”, “diagnostic”, but the list is not constrained, and others such groups such as (exposure|family|travel|nutitirional) history may be used.
-
item¶ A record of a specific investigation that was undertaken.
-
-
class
cardea.fhir.ClinicalImpression_Finding(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient’s condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called “ClinicalImpression” rather than “ClinicalAssessment” to avoid confusion with the recording of assessment tools such as Apgar score.
-
itemCodeableConcept¶ Specific text, code or reference for finding or diagnosis, which may include ruled-out or resolved conditions.
-
itemReference¶ Specific text, code or reference for finding or diagnosis, which may include ruled-out or resolved conditions.
-
basis¶ Which investigations support finding or diagnosis.
-
-
class
cardea.fhir.CodeableConcept(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
-
coding¶ A reference to a code defined by a terminology system.
-
text¶ A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
-
-
class
cardea.fhir.CodeSystem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA code system resource specifies a set of codes drawn from one or more code systems.
-
resourceType¶ This is a CodeSystem resource
-
url¶ An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this code system is (or will be) published. The URL SHOULD include the major version of the code system. For more information see [Technical and Business Versions](resource.html#versions). This is used in [Coding]{datatypes.html#Coding}.system.
-
identifier¶ A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding]{datatypes.html#Coding}.version.
-
name¶ A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the code system.
-
status¶ The status of this code system. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the code system was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the code system changes.
-
publisher¶ The name of the individual or organization that published the code system.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the code system from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate code system instances.
-
jurisdiction¶ A legal or geographic region in which the code system is intended to be used.
-
purpose¶ Explaination of why this code system is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.
-
caseSensitive¶ If code comparison is case sensitive when codes within this system are compared to each other.
-
valueSet¶ Canonical URL of value set that contains the entire code system.
-
hierarchyMeaning¶ The meaning of the hierarchy of concepts.
-
compositional¶ True If code system defines a post-composition grammar.
-
versionNeeded¶ This flag is used to signify that the code system has not (or does not) maintain the definitions, and a version must be specified when referencing this code system.
-
content¶ How much of the content of the code system - the concepts and codes it defines - are represented in this resource.
-
count¶ The total number of concepts defined by the code system. Where the code system has a compositional grammar, the count refers to the number of base (primitive) concepts.
-
filter¶ A filter that can be used in a value set compose statement when selecting concepts using a filter.
-
property¶ A property defines an additional slot through which additional information can be provided about a concept.
-
concept¶ Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meaning of the hierarchical relationships are.
-
-
class
cardea.fhir.CodeSystem_Filter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA code system resource specifies a set of codes drawn from one or more code systems.
-
code¶ The code that identifies this filter when it is used in the instance.
-
description¶ A description of how or why the filter is used.
-
operator¶ A list of operators that can be used with the filter.
-
value¶ A description of what the value for the filter should be.
-
-
class
cardea.fhir.CodeSystem_Property(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA code system resource specifies a set of codes drawn from one or more code systems.
-
code¶ A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters.
-
uri¶ Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system.
-
description¶ A description of the property- why it is defined, and how its value might be used.
-
type¶ The type of the property value. Properties of type “code” contain a code defined by the code system (e.g. a reference to anotherr defined concept).
-
-
class
cardea.fhir.CodeSystem_Concept(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA code system resource specifies a set of codes drawn from one or more code systems.
-
code¶ A code - a text symbol - that uniquely identifies the concept within the code system.
-
display¶ A human readable string that is the recommended default way to present this concept to a user.
-
definition¶ The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept.
-
designation¶ Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc.
-
property¶ A property value for this concept.
-
concept¶ Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning.
-
-
class
cardea.fhir.CodeSystem_Designation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA code system resource specifies a set of codes drawn from one or more code systems.
-
language¶ The language this designation is defined for.
-
use¶ A code that details how this designation would be used.
-
value¶ The text value for this designation.
-
-
class
cardea.fhir.CodeSystem_Property1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA code system resource specifies a set of codes drawn from one or more code systems.
-
code¶ A code that is a reference to CodeSystem.property.code.
-
valueCode¶ The value of this property.
-
valueCoding¶ The value of this property.
-
valueString¶ The value of this property.
-
valueInteger¶ The value of this property.
-
valueBoolean¶ The value of this property.
-
valueDateTime¶ The value of this property.
-
-
class
cardea.fhir.Coding(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reference to a code defined by a terminology system.
-
system¶ The identification of the code system that defines the meaning of the symbol in the code.
-
version¶ The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
-
code¶ A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
-
display¶ A representation of the meaning of the code in the system, following the rules of the system.
-
userSelected¶ Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).
-
-
class
cardea.fhir.Communication(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.
-
resourceType¶ This is a Communication resource
-
identifier¶ Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
definition¶ A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.
-
basedOn¶ An order, proposal or plan fulfilled in whole or in part by this Communication.
-
partOf¶ Part of this action.
-
status¶ The status of the transmission.
-
notDone¶ If true, indicates that the described communication event did not actually occur.
-
notDoneReason¶ Describes why the communication event did not occur in coded and/or textual form.
-
category¶ The type of message conveyed such as alert, notification, reminder, instruction, etc.
-
medium¶ A channel that was used for this communication (e.g. email, fax).
-
subject¶ The patient or group that was the focus of this communication.
-
recipient¶ The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).
-
topic¶ The resources which were responsible for or related to producing this communication.
-
context¶ The encounter within which the communication was sent.
-
sent¶ The time when this communication was sent.
-
received¶ The time when this communication arrived at the destination.
-
sender¶ The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
-
reasonCode¶ The reason or justification for the communication.
-
reasonReference¶ Indicates another resource whose existence justifies this communication.
-
payload¶ Text, attachment(s), or resource(s) that was communicated to the recipient.
-
note¶ Additional notes or commentary about the communication by the sender, receiver or other interested parties.
-
-
class
cardea.fhir.Communication_Payload(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.
-
contentString¶ A communicated content (or for multi-part communications, one portion of the communication).
-
contentAttachment¶ A communicated content (or for multi-part communications, one portion of the communication).
-
contentReference¶ A communicated content (or for multi-part communications, one portion of the communication).
-
-
class
cardea.fhir.CommunicationRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
-
resourceType¶ This is a CommunicationRequest resource
-
identifier¶ A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.
-
basedOn¶ A plan or proposal that is fulfilled in whole or in part by this request.
-
replaces¶ Completed or terminated request(s) whose function is taken by this new request.
-
groupIdentifier¶ A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
-
status¶ The status of the proposal or order.
-
category¶ The type of message to be sent such as alert, notification, reminder, instruction, etc.
-
priority¶ Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
-
medium¶ A channel that was used for this communication (e.g. email, fax).
-
subject¶ The patient or group that is the focus of this communication request.
-
recipient¶ The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
-
topic¶ The resources which were related to producing this communication request.
-
context¶ The encounter or episode of care within which the communication request was created.
-
payload¶ Text, attachment(s), or resource(s) to be communicated to the recipient.
-
occurrenceDateTime¶ The time when this communication is to occur.
-
occurrencePeriod¶ The time when this communication is to occur.
For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
-
sender¶ The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
-
requester¶ The individual who initiated the request and has responsibility for its activation.
-
reasonCode¶ Describes why the request is being made in coded or textual form.
-
reasonReference¶ Indicates another resource whose existence justifies this request.
-
note¶ Comments made about the request by the requester, sender, recipient, subject or other participants.
-
-
class
cardea.fhir.CommunicationRequest_Payload(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
-
contentString¶ The communicated content (or for multi-part communications, one portion of the communication).
-
contentAttachment¶ The communicated content (or for multi-part communications, one portion of the communication).
-
contentReference¶ The communicated content (or for multi-part communications, one portion of the communication).
-
-
class
cardea.fhir.CommunicationRequest_Requester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
-
agent¶ The device, practitioner, etc. who initiated the request.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
-
class
cardea.fhir.CompartmentDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA compartment definition that defines how resources are accessed on a server.
-
resourceType¶ This is a CompartmentDefinition resource
-
url¶ An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this compartment definition is (or will be) published. The URL SHOULD include the major version of the compartment definition. For more information see [Technical and Business Versions](resource.html#versions).
-
name¶ A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the compartment definition.
-
status¶ The status of this compartment definition. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the compartment definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes.
-
publisher¶ The name of the individual or organization that published the compartment definition.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the compartment definition from a consumer’s perspective.
-
purpose¶ Explaination of why this compartment definition is needed and why it has been designed as it has.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate compartment definition instances.
-
jurisdiction¶ A legal or geographic region in which the compartment definition is intended to be used.
-
code¶ Which compartment this definition describes.
-
search¶ Whether the search syntax is supported,.
-
resource¶ Information about how a resource is related to the compartment.
-
-
class
cardea.fhir.CompartmentDefinition_Resource(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA compartment definition that defines how resources are accessed on a server.
-
code¶ The name of a resource supported by the server.
-
param¶ The name of a search parameter that represents the link to the compartment. More than one may be listed because a resource may be linked to a compartment in more than one way,.
-
documentation¶ Additional documentation about the resource and compartment.
-
-
class
cardea.fhir.Composition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.
-
resourceType¶ This is a Composition resource
-
identifier¶ Logical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.
-
status¶ The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
-
type¶ Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
-
class¶ A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.
-
subject¶ Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).
-
encounter¶ Describes the clinical encounter or type of care this documentation is associated with.
-
date¶ The composition editing time, when the composition was last logically changed by the author.
Identifies who is responsible for the information in the composition, not necessarily who typed it in.
-
title¶ Official human-readable label for the composition.
-
confidentiality¶ The code specifying the level of confidentiality of the Composition.
-
attester¶ A participant who has attested to the accuracy of the composition/document.
-
custodian¶ Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
-
relatesTo¶ Relationships that this composition has with other compositions or documents that already exist.
-
event¶ The clinical service, such as a colonoscopy or an appendectomy, being documented.
-
section¶ The root of the sections that make up the composition.
-
-
class
cardea.fhir.Composition_Attester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.
-
mode¶ The type of attestation the authenticator offers.
-
time¶ When the composition was attested by the party.
-
party¶ Who attested the composition in the specified way.
-
-
class
cardea.fhir.Composition_RelatesTo(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.
-
code¶ The type of relationship that this composition has with anther composition or document.
-
targetIdentifier¶ The target composition/document of this relationship.
-
targetReference¶ The target composition/document of this relationship.
-
-
class
cardea.fhir.Composition_Event(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.
-
code¶ This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a “History and Physical Report” in which the procedure being documented is necessarily a “History and Physical” act.
-
period¶ The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.
-
detail¶ The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.
-
-
class
cardea.fhir.Composition_Section(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.
-
title¶ The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
-
code¶ A code identifying the kind of content contained within the section. This must be consistent with the section title.
-
text¶ A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it “clinically safe” for a human to just read the narrative.
-
mode¶ How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
-
orderedBy¶ Specifies the order applied to the items in the section entries.
-
entry¶ A reference to the actual resource from which the narrative in the section is derived.
-
emptyReason¶ If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
-
section¶ A nested sub-section within this section.
-
-
class
cardea.fhir.ConceptMap(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.
-
resourceType¶ This is a ConceptMap resource
-
url¶ An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published. The URL SHOULD include the major version of the concept map. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the concept map.
-
status¶ The status of this concept map. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the concept map was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes.
-
publisher¶ The name of the individual or organization that published the concept map.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the concept map from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate concept map instances.
-
jurisdiction¶ A legal or geographic region in which the concept map is intended to be used.
-
purpose¶ Explaination of why this concept map is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.
-
sourceUri¶ The source value set that specifies the concepts that are being mapped.
-
sourceReference¶ The source value set that specifies the concepts that are being mapped.
-
targetUri¶ The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.
-
targetReference¶ The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.
-
group¶ A group of mappings that all have the same source and target system.
-
-
class
cardea.fhir.ConceptMap_Group(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.
-
source¶ An absolute URI that identifies the Code System (if the source is a value set that crosses more than one code system).
-
sourceVersion¶ The specific version of the code system, as determined by the code system authority.
-
target¶ An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems).
-
targetVersion¶ The specific version of the code system, as determined by the code system authority.
-
element¶ Mappings for an individual concept in the source to one or more concepts in the target.
-
unmapped¶ What to do when there is no match in the mappings in the group.
-
-
class
cardea.fhir.ConceptMap_Element(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.
-
code¶ Identity (code or path) or the element/item being mapped.
-
display¶ The display for the code. The display is only provided to help editors when editing the concept map.
-
target¶ A concept from the target value set that this concept maps to.
-
-
class
cardea.fhir.ConceptMap_Target(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.
-
code¶ Identity (code or path) or the element/item that the map refers to.
-
display¶ The display for the code. The display is only provided to help editors when editing the concept map.
-
equivalence¶ The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is ‘wider’ than the source).
-
comment¶ A description of status/issues in mapping that conveys additional information not represented in the structured data.
-
dependsOn¶ A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.
-
product¶ A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.
-
-
class
cardea.fhir.ConceptMap_DependsOn(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.
-
property¶ A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somwhere that is labeled to correspond with a code system property.
-
system¶ An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems).
-
code¶ Identity (code or path) or the element/item/ValueSet that the map depends on / refers to.
-
display¶ The display for the code. The display is only provided to help editors when editing the concept map.
-
-
class
cardea.fhir.ConceptMap_Unmapped(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.
-
mode¶ Defines which action to take if there is no match in the group. One of 3 actions is possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).
-
code¶ The fixed code to use when the mode = ‘fixed’ - all unmapped codes are mapped to a single fixed code.
-
display¶ The display for the code. The display is only provided to help editors when editing the concept map.
-
url¶ The canonical URL of the map to use if this map contains no mapping.
-
-
class
cardea.fhir.Condition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
-
resourceType¶ This is a Condition resource
-
identifier¶ This records identifiers associated with this condition that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
clinicalStatus¶ The clinical status of the condition.
-
verificationStatus¶ The verification status to support the clinical status of the condition.
-
category¶ A category assigned to the condition.
-
severity¶ A subjective assessment of the severity of the condition as evaluated by the clinician.
-
code¶ Identification of the condition, problem or diagnosis.
-
bodySite¶ The anatomical location where this condition manifests itself.
-
subject¶ Indicates the patient or group who the condition record is associated with.
-
context¶ Encounter during which the condition was first asserted.
-
onsetDateTime¶ Estimated or actual date or date-time the condition began, in the opinion of the clinician.
-
onsetAge¶ Estimated or actual date or date-time the condition began, in the opinion of the clinician.
-
onsetPeriod¶ Estimated or actual date or date-time the condition began, in the opinion of the clinician.
-
onsetRange¶ Estimated or actual date or date-time the condition began, in the opinion of the clinician.
-
onsetString¶ Estimated or actual date or date-time the condition began, in the opinion of the clinician.
-
abatementDateTime¶ The date or estimated date that the condition resolved or went into remission. This is called “abatement” because of the many overloaded connotations associated with “remission” or “resolution” - Conditions are never really resolved, but they can abate.
-
abatementAge¶ The date or estimated date that the condition resolved or went into remission. This is called “abatement” because of the many overloaded connotations associated with “remission” or “resolution” - Conditions are never really resolved, but they can abate.
-
abatementBoolean¶ The date or estimated date that the condition resolved or went into remission. This is called “abatement” because of the many overloaded connotations associated with “remission” or “resolution” - Conditions are never really resolved, but they can abate.
-
abatementPeriod¶ The date or estimated date that the condition resolved or went into remission. This is called “abatement” because of the many overloaded connotations associated with “remission” or “resolution” - Conditions are never really resolved, but they can abate.
-
abatementRange¶ The date or estimated date that the condition resolved or went into remission. This is called “abatement” because of the many overloaded connotations associated with “remission” or “resolution” - Conditions are never really resolved, but they can abate.
-
abatementString¶ The date or estimated date that the condition resolved or went into remission. This is called “abatement” because of the many overloaded connotations associated with “remission” or “resolution” - Conditions are never really resolved, but they can abate.
-
assertedDate¶ The date on which the existance of the Condition was first asserted or acknowledged.
-
asserter¶ Individual who is making the condition statement.
-
stage¶ Clinical stage or grade of a condition. May include formal severity assessments.
-
evidence¶ Supporting Evidence / manifestations that are the basis on which this condition is suspected or confirmed.
-
note¶ Additional information about the Condition. This is a general notes/comments entry for description of the Condition, its diagnosis and prognosis.
-
-
class
cardea.fhir.Condition_Stage(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
-
summary¶ A simple summary of the stage such as “Stage 3”. The determination of the stage is disease-specific.
-
assessment¶ Reference to a formal record of the evidence on which the staging assessment is based.
-
-
class
cardea.fhir.Condition_Evidence(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA clinical condition, problem, diagnosis, or other event, situation, issue, or clinical concept that has risen to a level of concern.
-
code¶ A manifestation or symptom that led to the recording of this condition.
-
detail¶ Links to other relevant information, including pathology reports.
-
-
class
cardea.fhir.Consent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
-
resourceType¶ This is a Consent resource
-
identifier¶ Unique identifier for this copy of the Consent Statement.
-
status¶ Indicates the current state of this consent.
-
category¶ A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
-
patient¶ The patient/healthcare consumer to whom this consent applies.
-
period¶ Relevant time or time-period when this Consent is applicable.
-
dateTime¶ When this Consent was issued / created / indexed.
-
consentingParty¶ Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
-
actor¶ Who or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. ‘admitting officers’).
-
action¶ Actions controlled by this consent.
-
organization¶ The organization that manages the consent, and the framework within which it is executed.
-
sourceAttachment¶ The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
-
sourceIdentifier¶ The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
-
sourceReference¶ The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
-
policy¶ The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
-
policyRule¶ A referece to the specific computable policy.
-
securityLabel¶ A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.
-
purpose¶ The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.
-
dataPeriod¶ Clinical or Operational Relevant period of time that bounds the data controlled by this consent.
-
data¶ The resources controlled by this consent, if specific resources are referenced.
-
except¶ An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
-
-
class
cardea.fhir.Consent_Actor(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
-
role¶ How the individual is involved in the resources content that is described in the consent.
-
reference¶ The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. ‘admitting officers’).
-
-
class
cardea.fhir.Consent_Policy(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives.
-
uri¶ The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
-
class
cardea.fhir.Consent_Data(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
-
meaning¶ How the resource reference is interpreted when testing consent restrictions.
-
reference¶ A reference to a specific resource that defines which resources are covered by this consent.
-
-
class
cardea.fhir.Consent_Except(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
-
type¶ Action to take - permit or deny - when the exception conditions are met.
-
period¶ The timeframe in this exception is valid.
-
actor¶ Who or what is controlled by this Exception. Use group to identify a set of actors by some property they share (e.g. ‘admitting officers’).
-
action¶ Actions controlled by this Exception.
-
securityLabel¶ A set of security labels that define which resources are controlled by this exception. If more than one label is specified, all resources must have all the specified labels.
-
purpose¶ The context of the activities a user is taking - why the user is accessing the data - that are controlled by this exception.
-
class¶ The class of information covered by this exception. The type can be a FHIR resource type, a profile on a type, or a CDA document, or some other type that indicates what sort of information the consent relates to.
-
code¶ If this code is found in an instance, then the exception applies.
-
dataPeriod¶ Clinical or Operational Relevant period of time that bounds the data controlled by this exception.
-
data¶ The resources controlled by this exception, if specific resources are referenced.
-
-
class
cardea.fhir.Consent_Actor1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
-
role¶ How the individual is involved in the resources content that is described in the exception.
-
reference¶ The resource that identifies the actor. To identify a actors by type, use group to identify a set of actors by some property they share (e.g. ‘admitting officers’).
-
-
class
cardea.fhir.Consent_Data1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.
-
meaning¶ How the resource reference is interpreted when testing consent restrictions.
-
reference¶ A reference to a specific resource that defines which resources are covered by this consent.
-
-
class
cardea.fhir.ContactDetail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseSpecifies contact information for a person or organization.
-
name¶ The name of an individual to contact.
-
telecom¶ The contact details for the individual (if a name was provided) or the organization.
-
-
class
cardea.fhir.ContactPoint(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDetails for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
-
system¶ Telecommunications form for contact point - what communications system is required to make use of the contact.
-
value¶ The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
-
use¶ Identifies the purpose for the contact point.
-
rank¶ Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.
-
period¶ Time period when the contact point was/is in use.
-
-
class
cardea.fhir.Contract(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
resourceType¶ This is a Contract resource
-
identifier¶ Unique identifier for this Contract.
-
status¶ The status of the resource instance.
-
issued¶ When this Contract was issued.
-
applies¶ Relevant time or time-period when this Contract is applicable.
-
subject¶ The target entity impacted by or of interest to parties to the agreement.
-
topic¶ The matter of concern in the context of this agreement.
A formally or informally recognized grouping of people, principals, organizations, or jurisdictions formed for the purpose of achieving some form of collective action such as the promulgation, administration and enforcement of contracts and policies.
-
domain¶ Recognized governance framework or system operating with a circumscribed scope in accordance with specified principles, policies, processes or procedures for managing rights, actions, or behaviors of parties or principals relative to resources.
-
type¶ Type of Contract such as an insurance policy, real estate contract, a will, power of attorny, Privacy or Security policy , trust framework agreement, etc.
-
subType¶ More specific type or specialization of an overarching or more general contract such as auto insurance, home owner insurance, prenupial agreement, Advanced-Directive, or privacy consent.
-
action¶ Action stipulated by this Contract.
-
actionReason¶ Reason for action stipulated by this Contract.
-
decisionType¶ The type of decision made by a grantor with respect to an offer made by a grantee.
-
contentDerivative¶ The minimal content derived from the basal information source at a specific stage in its lifecycle.
-
securityLabel¶ A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.
-
agent¶ An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
-
signer¶ Parties with legal standing in the Contract, including the principal parties, the grantor(s) and grantee(s), which are any person or organization bound by the contract, and any ancillary parties, which facilitate the execution of the contract such as a notary or witness.
-
valuedItem¶ Contract Valued Item List.
-
term¶ One or more Contract Provisions, which may be related and conveyed as a group, and may contain nested groups.
-
bindingAttachment¶ Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the “source of truth” and which would be the basis for legal action related to enforcement of this Contract.
-
bindingReference¶ Legally binding Contract: This is the signed and legally recognized representation of the Contract, which is considered the “source of truth” and which would be the basis for legal action related to enforcement of this Contract.
-
friendly¶ The “patient friendly language” versionof the Contract in whole or in parts. “Patient friendly language” means the representation of the Contract and Contract Provisions in a manner that is readily accessible and understandable by a layperson in accordance with best practices for communication styles that ensure that those agreeing to or signing the Contract understand the roles, actions, obligations, responsibilities, and implication of the agreement.
-
legal¶ List of Legal expressions or representations of this Contract.
-
rule¶ List of Computable Policy Rule Language Representations of this Contract.
-
-
class
cardea.fhir.Contract_Agent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
actor¶ Who or what parties are assigned roles in this Contract.
-
role¶ Role type of agent assigned roles in this Contract.
-
-
class
cardea.fhir.Contract_Signer(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
type¶ Role of this Contract signer, e.g. notary, grantee.
-
party¶ Party which is a signator to this Contract.
-
signature¶ Legally binding Contract DSIG signature contents in Base64.
-
-
class
cardea.fhir.Contract_ValuedItem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
entityCodeableConcept¶ Specific type of Contract Valued Item that may be priced.
-
entityReference¶ Specific type of Contract Valued Item that may be priced.
-
identifier¶ Identifies a Contract Valued Item instance.
-
effectiveTime¶ Indicates the time during which this Contract ValuedItem information is effective.
-
quantity¶ Specifies the units by which the Contract Valued Item is measured or counted, and quantifies the countable or measurable Contract Valued Item instances.
-
unitPrice¶ A Contract Valued Item unit valuation measure.
-
factor¶ A real number that represents a multiplier used in determining the overall value of the Contract Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
points¶ An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Valued Item delivered. The concept of Points allows for assignment of point values for a Contract Valued Item, such that a monetary amount can be assigned to each point.
-
net¶ Expresses the product of the Contract Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
-
class
cardea.fhir.Contract_Term(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
identifier¶ Unique identifier for this particular Contract Provision.
-
issued¶ When this Contract Provision was issued.
-
applies¶ Relevant time or time-period when this Contract Provision is applicable.
-
type¶ Type of Contract Provision such as specific requirements, purposes for actions, obligations, prohibitions, e.g. life time maximum benefit.
-
subType¶ Subtype of this Contract Provision, e.g. life time maximum payment for a contract term for specific valued item, e.g. disability payment.
-
topic¶ The matter of concern in the context of this provision of the agrement.
-
action¶ Action stipulated by this Contract Provision.
-
actionReason¶ Reason or purpose for the action stipulated by this Contract Provision.
-
securityLabel¶ A set of security labels that define which terms are controlled by this condition.
-
agent¶ An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
-
text¶ Human readable form of this Contract Provision.
-
valuedItem¶ Contract Provision Valued Item List.
-
group¶ Nested group of Contract Provisions.
-
-
class
cardea.fhir.Contract_Agent1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
actor¶ The agent assigned a role in this Contract Provision.
-
role¶ Role played by the agent assigned this role in the execution of this Contract Provision.
-
-
class
cardea.fhir.Contract_ValuedItem1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
entityCodeableConcept¶ Specific type of Contract Provision Valued Item that may be priced.
-
entityReference¶ Specific type of Contract Provision Valued Item that may be priced.
-
identifier¶ Identifies a Contract Provision Valued Item instance.
-
effectiveTime¶ Indicates the time during which this Contract Term ValuedItem information is effective.
-
quantity¶ Specifies the units by which the Contract Provision Valued Item is measured or counted, and quantifies the countable or measurable Contract Term Valued Item instances.
-
unitPrice¶ A Contract Provision Valued Item unit valuation measure.
-
factor¶ A real number that represents a multiplier used in determining the overall value of the Contract Provision Valued Item delivered. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
points¶ An amount that expresses the weighting (based on difficulty, cost and/or resource intensiveness) associated with the Contract Provision Valued Item delivered. The concept of Points allows for assignment of point values for a Contract ProvisionValued Item, such that a monetary amount can be assigned to each point.
-
net¶ Expresses the product of the Contract Provision Valued Item unitQuantity and the unitPriceAmt. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
-
class
cardea.fhir.Contract_Friendly(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
contentAttachment¶ Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.
-
contentReference¶ Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability.
-
-
class
cardea.fhir.Contract_Legal(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
contentAttachment¶ Contract legal text in human renderable form.
-
contentReference¶ Contract legal text in human renderable form.
-
-
class
cardea.fhir.Contract_Rule(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal agreement between parties regarding the conduct of business, exchange of information or other matters.
-
contentAttachment¶ Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).
-
contentReference¶ Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal).
-
-
class
cardea.fhir.Contributor(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.
-
type¶ The type of contributor.
-
name¶ The name of the individual or organization responsible for the contribution.
-
contact¶ Contact details to assist a user in finding and communicating with the contributor.
-
-
class
cardea.fhir.Count(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
class
cardea.fhir.Coverage(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseFinancial instrument which may be used to reimburse or pay for health care products and services.
-
resourceType¶ This is a Coverage resource
-
identifier¶ The main (and possibly only) identifier for the coverage - often referred to as a Member Id, Certificate number, Personal Health Number or Case ID. May be constructed as the concatination of the Coverage.SubscriberID and the Coverage.dependant.
-
status¶ The status of the resource instance.
-
type¶ The type of coverage: social program, medical plan, accident coverage (workers compensation, auto), group health or payment by an individual or organization.
-
policyHolder¶ The party who ‘owns’ the insurance policy, may be an individual, corporation or the subscriber’s employer.
-
subscriber¶ The party who has signed-up for or ‘owns’ the contractual relationship to the policy or to whom the benefit of the policy for services rendered to them or their family is due.
-
subscriberId¶ The insurer assigned ID for the Subscriber.
-
beneficiary¶ The party who benefits from the insurance coverage., the patient when services are provided.
-
relationship¶ The relationship of beneficiary (patient) to the subscriber.
-
period¶ Time period during which the coverage is in force. A missing start date indicates the start date isn’t known, a missing end date means the coverage is continuing to be in force.
-
payor¶ The program or plan underwriter or payor including both insurance and non-insurance agreements, such as patient-pay agreements. May provide multiple identifiers such as insurance company identifier or business identifier (BIN number).
-
grouping¶ A suite of underwrite specific classifiers, for example may be used to identify a class of coverage or employer group, Policy, Plan.
-
dependent¶ A unique identifier for a dependent under the coverage.
-
sequence¶ An optional counter for a particular instance of the identified coverage which increments upon each renewal.
-
order¶ The order of applicability of this coverage relative to other coverages which are currently inforce. Note, there may be gaps in the numbering and this does not imply primary, secondard etc. as the specific positioning of coverages depends upon the episode of care.
-
network¶ The insurer-specific identifier for the insurer-defined network of providers to which the beneficiary may seek treatment which will be covered at the ‘in-network’ rate, otherwise ‘out of network’ terms and conditions apply.
-
contract¶ The policy(s) which constitute this insurance coverage.
-
-
class
cardea.fhir.Coverage_Grouping(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseFinancial instrument which may be used to reimburse or pay for health care products and services.
-
group¶ Identifies a style or collective of coverage issued by the underwriter, for example may be used to identify an employer group. May also be referred to as a Policy or Group ID.
-
groupDisplay¶ A short description for the group.
-
subGroup¶ Identifies a style or collective of coverage issued by the underwriter, for example may be used to identify a subset of an employer group.
-
subGroupDisplay¶ A short description for the subgroup.
-
plan¶ Identifies a style or collective of coverage issued by the underwriter, for example may be used to identify a collection of benefits provided to employees. May be referred to as a Section or Division ID.
-
planDisplay¶ A short description for the plan.
-
subPlan¶ Identifies a sub-style or sub-collective of coverage issued by the underwriter, for example may be used to identify a subset of a collection of benefits provided to employees.
-
subPlanDisplay¶ A short description for the subplan.
-
class¶ Identifies a style or collective of coverage issues by the underwriter, for example may be used to identify a class of coverage such as a level of deductables or co-payment.
-
classDisplay¶ A short description for the class.
-
subClass¶ Identifies a sub-style or sub-collective of coverage issues by the underwriter, for example may be used to identify a subclass of coverage such as a sub-level of deductables or co-payment.
-
subClassDisplay¶ A short description for the subclass.
-
-
class
cardea.fhir.DataElement(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe formal description of a single piece of information that can be gathered and reported.
-
resourceType¶ This is a DataElement resource
-
url¶ An absolute URI that is used to identify this data element when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this data element is (or will be) published. The URL SHOULD include the major version of the data element. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this data element when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the data element when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the data element author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
status¶ The status of this data element. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this data element is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the data element was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the data element changes.
-
publisher¶ The name of the individual or organization that published the data element.
-
name¶ A natural language name identifying the data element. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the data element.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate data element instances.
-
jurisdiction¶ A legal or geographic region in which the data element is intended to be used.
-
copyright¶ A copyright statement relating to the data element and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the data element.
-
stringency¶ Identifies how precise the data element is in its definition.
-
mapping¶ Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.
-
element¶ Defines the structure, type, allowed values and other constraining characteristics of the data element.
-
-
class
cardea.fhir.DataElement_Mapping(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe formal description of a single piece of information that can be gathered and reported.
-
identity¶ An internal id that is used to identify this mapping set when specific mappings are made on a per-element basis.
-
uri¶ An absolute URI that identifies the specification that this mapping is expressed to.
-
name¶ A name for the specification that is being mapped to.
-
comment¶ Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.
-
-
class
cardea.fhir.DataRequirement(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
-
type¶ The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
-
profile¶ The profile of the required data, specified as the uri of the profile definition.
-
mustSupport¶ Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. Note that the value for this element can be a path to allow references to nested elements. In that case, all the elements along the path must be supported.
-
codeFilter¶ Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data.
-
dateFilter¶ Date filters specify additional constraints on the data in terms of the applicable date range for specific elements.
-
-
class
cardea.fhir.DataRequirement_CodeFilter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
-
path¶ The code-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
-
valueSetString¶ The valueset for the code filter. The valueSet and value elements are exclusive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
-
valueSetReference¶ The valueset for the code filter. The valueSet and value elements are exclusive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
-
valueCode¶ The codes for the code filter. Only one of valueSet, valueCode, valueCoding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes.
-
valueCoding¶ The Codings for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified Codings.
-
valueCodeableConcept¶ The CodeableConcepts for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified CodeableConcepts.
-
-
class
cardea.fhir.DataRequirement_DateFilter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
-
path¶ The date-valued attribute of the filter. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant. The path must resolve to an element of type dateTime, Period, Schedule, or Timing.
-
valueDateTime¶ The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration from now.
-
valuePeriod¶ The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration from now.
-
valueDuration¶ The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration from now.
-
-
class
cardea.fhir.DetectedIssue(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIndicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.
-
resourceType¶ This is a DetectedIssue resource
-
identifier¶ Business identifier associated with the detected issue record.
-
status¶ Indicates the status of the detected issue.
-
category¶ Identifies the general type of issue identified.
-
severity¶ Indicates the degree of importance associated with the identified issue based on the potential impact on the patient.
-
patient¶ Indicates the patient whose record the detected issue is associated with.
-
date¶ The date or date-time when the detected issue was initially identified.
Individual or device responsible for the issue being raised. For example, a decision support application or a pharmacist conducting a medication review.
-
implicated¶ Indicates the resource representing the current activity or proposed activity that is potentially problematic.
-
detail¶ A textual explanation of the detected issue.
-
reference¶ The literature, knowledge-base or similar reference that describes the propensity for the detected issue identified.
-
mitigation¶ Indicates an action that has been taken or is committed to to reduce or eliminate the likelihood of the risk identified by the detected issue from manifesting. Can also reflect an observation of known mitigating factors that may reduce/eliminate the need for any action.
-
-
class
cardea.fhir.DetectedIssue_Mitigation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIndicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc.
-
action¶ Describes the action that was taken or the observation that was made that reduces/eliminates the risk associated with the identified issue.
-
date¶ Indicates when the mitigating action was documented.
Identifies the practitioner who determined the mitigation and takes responsibility for the mitigation step occurring.
-
-
class
cardea.fhir.Device(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.
-
resourceType¶ This is a Device resource
-
identifier¶ Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
-
udi¶ [Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package.
-
status¶ Status of the Device availability.
-
type¶ Code or identifier to identify a kind of device.
-
lotNumber¶ Lot number assigned by the manufacturer.
-
manufacturer¶ A name of the manufacturer.
-
manufactureDate¶ The date and time when the device was manufactured.
-
expirationDate¶ The date and time beyond which this device is no longer valid or should not be used (if applicable).
-
model¶ The “model” is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.
-
version¶ The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.
-
patient¶ Patient information, If the device is affixed to a person.
-
owner¶ An organization that is responsible for the provision and ongoing maintenance of the device.
-
contact¶ Contact details for an organization or a particular human that is responsible for the device.
-
location¶ The place where the device can be found.
-
url¶ A network address on which the device may be contacted directly.
-
note¶ Descriptive information, usage information or implantation information that is not captured in an existing element.
-
safety¶ Provides additional safety characteristics about a medical device. For example devices containing latex.
-
-
class
cardea.fhir.Device_Udi(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.
-
deviceIdentifier¶ The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.
-
name¶ Name of device as used in labeling or catalog.
-
jurisdiction¶ The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace. with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.
-
carrierHRF¶ The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.
-
carrierAIDC¶ The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - E.g a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded.
-
issuer¶ Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di.
-
entryType¶ A coded entry to indicate how the data was entered.
-
-
class
cardea.fhir.DeviceComponent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe characteristics, operational status and capabilities of a medical-related component of a medical device.
-
resourceType¶ This is a DeviceComponent resource
-
identifier¶ The locally assigned unique identification by the software. For example: handle ID.
-
type¶ The component type as defined in the object-oriented or metric nomenclature partition.
-
lastSystemChange¶ The timestamp for the most recent system change which includes device configuration or setting change.
-
source¶ The link to the source Device that contains administrative device information such as manufacture, serial number, etc.
-
parent¶ The link to the parent resource. For example: Channel is linked to its VMD parent.
-
operationalStatus¶ The current operational status of the device. For example: On, Off, Standby, etc.
-
parameterGroup¶ The parameter group supported by the current device component that is based on some nomenclature, e.g. cardiovascular.
-
measurementPrinciple¶ The physical principle of the measurement. For example: thermal, chemical, acoustical, etc.
-
productionSpecification¶ The production specification such as component revision, serial number, etc.
-
languageCode¶ The language code for the human-readable text string produced by the device. This language code will follow the IETF language tag. Example: en-US.
-
-
class
cardea.fhir.DeviceComponent_ProductionSpecification(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe characteristics, operational status and capabilities of a medical-related component of a medical device.
-
specType¶ The specification type, such as, serial number, part number, hardware revision, software revision, etc.
-
componentId¶ The internal component unique identification. This is a provision for manufacture specific standard components using a private OID. 11073-10101 has a partition for private OID semantic that the manufacturer can make use of.
-
productionSpec¶ The printable string defining the component.
-
-
class
cardea.fhir.DeviceMetric(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes a measurement, calculation or setting capability of a medical device.
-
resourceType¶ This is a DeviceMetric resource
-
identifier¶ Describes the unique identification of this metric that has been assigned by the device or gateway software. For example: handle ID. It should be noted that in order to make the identifier unique, the system element of the identifier should be set to the unique identifier of the device.
-
type¶ Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc.
-
unit¶ Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc.
-
source¶ Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc.
-
parent¶ Describes the link to the DeviceComponent that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a DeviceComponent that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location.
-
operationalStatus¶ Indicates current operational state of the device. For example: On, Off, Standby, etc.
-
color¶ Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta.
-
category¶ Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation.
-
measurementPeriod¶ Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured.
-
calibration¶ Describes the calibrations that have been performed or that are required to be performed.
-
-
class
cardea.fhir.DeviceMetric_Calibration(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes a measurement, calculation or setting capability of a medical device.
-
type¶ Describes the type of the calibration method.
-
state¶ Describes the state of the calibration.
-
time¶ Describes the time last calibration has been performed.
-
-
class
cardea.fhir.DeviceRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.
-
resourceType¶ This is a DeviceRequest resource
-
identifier¶ Identifiers assigned to this order by the orderer or by the receiver.
-
definition¶ Protocol or definition followed by this request. For example: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.
-
basedOn¶ Plan/proposal/order fulfilled by this request.
-
priorRequest¶ The request takes the place of the referenced completed or terminated request(s).
-
groupIdentifier¶ Composite request this is part of.
-
status¶ The status of the request.
-
intent¶ Whether the request is a proposal, plan, an original order or a reflex order.
-
priority¶ Indicates how quickly the {{title}} should be addressed with respect to other requests.
-
codeReference¶ The details of the device to be used.
-
codeCodeableConcept¶ The details of the device to be used.
-
subject¶ The patient who will use the device.
-
context¶ An encounter that provides additional context in which this request is made.
-
occurrenceDateTime¶ The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. “Every 8 hours”; “Three times a day”; “1/2 an hour before breakfast for 10 days from 23-Dec 2011:”; “15 Oct 2013, 17 Oct 2013 and 1 Nov 2013”.
-
occurrencePeriod¶ The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. “Every 8 hours”; “Three times a day”; “1/2 an hour before breakfast for 10 days from 23-Dec 2011:”; “15 Oct 2013, 17 Oct 2013 and 1 Nov 2013”.
-
occurrenceTiming¶ The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. “Every 8 hours”; “Three times a day”; “1/2 an hour before breakfast for 10 days from 23-Dec 2011:”; “15 Oct 2013, 17 Oct 2013 and 1 Nov 2013”.
When the request transitioned to being actionable.
-
requester¶ The individual who initiated the request and has responsibility for its activation.
-
performerType¶ Desired type of performer for doing the diagnostic testing.
-
performer¶ The desired perfomer for doing the diagnostic testing.
-
reasonCode¶ Reason or justification for the use of this device.
-
reasonReference¶ Reason or justification for the use of this device.
-
supportingInfo¶ Additional clinical information about the patient that may influence the request fulfilment. For example, this may includes body where on the subject’s the device will be used ( i.e. the target site).
-
note¶ Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.
-
relevantHistory¶ Key events in the history of the request.
-
-
class
cardea.fhir.DeviceRequest_Requester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.
-
agent¶ The device, practitioner, etc. who initiated the request.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
-
class
cardea.fhir.DeviceUseStatement(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a device being used by a patient where the record is the result of a report from the patient or another clinician.
-
resourceType¶ This is a DeviceUseStatement resource
-
identifier¶ An external identifier for this statement such as an IRI.
-
status¶ A code representing the patient or other source’s judgment about the state of the device used that this statement is about. Generally this will be active or completed.
-
subject¶ The patient who used the device.
-
whenUsed¶ The time period over which the device was used.
-
timingTiming¶ How often the device was used.
-
timingPeriod¶ How often the device was used.
-
timingDateTime¶ How often the device was used.
-
recordedOn¶ The time at which the statement was made/recorded.
-
source¶ Who reported the device was being used by the patient.
-
device¶ The details of the device used.
-
indication¶ Reason or justification for the use of the device.
-
bodySite¶ Indicates the site on the subject’s body where the device was used ( i.e. the target site).
-
note¶ Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.
-
-
class
cardea.fhir.DiagnosticReport(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.
-
resourceType¶ This is a DiagnosticReport resource
-
identifier¶ Identifiers assigned to this report by the performer or other systems.
-
basedOn¶ Details concerning a test or procedure requested.
-
status¶ The status of the diagnostic report as a whole.
-
category¶ A code that classifies the clinical discipline, department or diagnostic service that created the report (e.g. cardiology, biochemistry, hematology, MRI). This is used for searching, sorting and display purposes.
-
code¶ A code or name that describes this diagnostic report.
-
subject¶ The subject of the report. Usually, but not always, this is a patient. However diagnostic services also perform analyses on specimens collected from a variety of other sources.
-
context¶ The healthcare event (e.g. a patient and healthcare provider interaction) which this DiagnosticReport per is about.
-
effectiveDateTime¶ The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
-
effectivePeriod¶ The time or time-period the observed values are related to. When the subject of the report is a patient, this is usually either the time of the procedure or of specimen collection(s), but very often the source of the date/time is not known, only the date/time itself.
-
issued¶ The date and time that this version of the report was released from the source diagnostic service.
-
performer¶ Indicates who or what participated in producing the report.
-
specimen¶ Details about the specimens on which this diagnostic report is based.
-
result¶ Observations that are part of this diagnostic report. Observations can be simple name/value pairs (e.g. “atomic” results), or they can be grouping observations that include references to other members of the group (e.g. “panels”).
-
imagingStudy¶ One or more links to full details of any imaging performed during the diagnostic investigation. Typically, this is imaging performed by DICOM enabled modalities, but this is not required. A fully enabled PACS viewer can use this information to provide views of the source images.
-
image¶ A list of key images associated with this report. The images are generally created during the diagnostic process, and may be directly of the patient, or of treated specimens (i.e. slides of interest).
-
conclusion¶ Concise and clinically contextualized impression / summary of the diagnostic report.
-
codedDiagnosis¶ Codes for the conclusion.
-
presentedForm¶ Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they SHALL be semantically equivalent.
-
-
class
cardea.fhir.DiagnosticReport_Performer(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.
-
role¶ Describes the type of participation (e.g. a responsible party, author, or verifier).
-
actor¶ The reference to the practitioner or organization involved in producing the report. For example, the diagnostic service that is responsible for issuing the report.
-
-
class
cardea.fhir.DiagnosticReport_Image(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretations, and formatted representation of diagnostic reports.
-
comment¶ A comment about the image. Typically, this is used to provide an explanation for why the image is included, or to draw the viewer’s attention to important features.
-
link¶ Reference to the image source.
-
-
class
cardea.fhir.Distance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA length - a value with a unit that is a physical distance.
-
class
cardea.fhir.DocumentManifest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA collection of documents compiled for a purpose together with metadata that applies to the collection.
-
resourceType¶ This is a DocumentManifest resource
-
masterIdentifier¶ A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
-
identifier¶ Other identifiers associated with the document manifest, including version independent identifiers.
-
status¶ The status of this document manifest.
-
type¶ Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider.
-
subject¶ Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case).
-
created¶ When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.).
Identifies who is responsible for creating the manifest, and adding documents to it.
-
recipient¶ A patient, practitioner, or organization for which this set of documents is intended.
-
source¶ Identifies the source system, application, or software that produced the document manifest.
-
description¶ Human-readable description of the source document. This is sometimes known as the “title”.
-
content¶ The list of Documents included in the manifest.
Related identifiers or resources associated with the DocumentManifest.
-
-
class
cardea.fhir.DocumentManifest_Content(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA collection of documents compiled for a purpose together with metadata that applies to the collection.
-
pAttachment¶ The list of references to document content, or Attachment that consist of the parts of this document manifest. Usually, these would be document references, but direct references to Media or Attachments are also allowed.
-
pReference¶ The list of references to document content, or Attachment that consist of the parts of this document manifest. Usually, these would be document references, but direct references to Media or Attachments are also allowed.
-
-
class
cardea.fhir.DocumentManifest_Related(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA collection of documents compiled for a purpose together with metadata that applies to the collection.
-
identifier¶ Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers.
-
ref¶ Related Resource to this DocumentManifest. For example, Order, ProcedureRequest, Procedure, EligibilityRequest, etc.
-
-
class
cardea.fhir.DocumentReference(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reference to a document.
-
resourceType¶ This is a DocumentReference resource
-
masterIdentifier¶ Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
-
identifier¶ Other identifiers associated with the document, including version independent identifiers.
-
status¶ The status of this document reference.
-
docStatus¶ The status of the underlying document.
-
type¶ Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
-
class¶ A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
-
subject¶ Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).
-
created¶ When the document was created.
-
indexed¶ When the document reference was created.
Identifies who is responsible for adding the information to the document.
-
authenticator¶ Which person or organization authenticates that this document is valid.
-
custodian¶ Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
-
relatesTo¶ Relationships that this document has with other document references that already exist.
-
description¶ Human-readable description of the source document. This is sometimes known as the “title”.
-
securityLabel¶ A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the “reference” to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
-
content¶ The document and format referenced. There may be multiple content element repetitions, each with a different format.
-
context¶ The clinical context in which the document was prepared.
-
-
class
cardea.fhir.DocumentReference_RelatesTo(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reference to a document.
-
code¶ The type of relationship that this document has with anther document.
-
target¶ The target document of this relationship.
-
-
class
cardea.fhir.DocumentReference_Content(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reference to a document.
-
attachment¶ The document or URL of the document along with critical metadata to prove content has integrity.
-
format¶ An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.
-
-
class
cardea.fhir.DocumentReference_Context(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reference to a document.
-
encounter¶ Describes the clinical encounter or type of care that the document content is associated with.
-
event¶ This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a “History and Physical Report” in which the procedure being documented is necessarily a “History and Physical” act.
-
period¶ The time period over which the service that is described by the document was provided.
-
facilityType¶ The kind of facility where the patient was seen.
-
practiceSetting¶ This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
-
sourcePatientInfo¶ The Patient Information as known when the document was published. May be a reference to a version specific, or contained.
Related identifiers or resources associated with the DocumentReference.
-
-
class
cardea.fhir.DocumentReference_Related(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reference to a document.
-
identifier¶ Related identifier to this DocumentReference. If both id and ref are present they shall refer to the same thing.
-
ref¶ Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing.
-
-
class
cardea.fhir.DomainResource(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA resource that includes narrative, extensions, and contained resources.
-
text¶ A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it “clinically safe” for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
-
contained¶ These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
-
extension¶ May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
modifierExtension¶ May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
-
-
class
cardea.fhir.Dosage(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIndicates how the medication is/was taken or should be taken by the patient.
-
sequence¶ Indicates the order in which the dosage instructions should be applied or interpreted.
-
text¶ Free text dosage instructions e.g. SIG.
-
additionalInstruction¶ Supplemental instruction - e.g. “with meals”.
-
patientInstruction¶ Instructions in terms that are understood by the patient or consumer.
-
timing¶ When medication should be administered.
-
asNeededBoolean¶ Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
-
asNeededCodeableConcept¶ Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).
-
site¶ Body site to administer to.
-
route¶ How drug should enter body.
-
method¶ Technique for administering medication.
-
doseRange¶ Amount of medication per dose.
-
doseSimpleQuantity¶ Amount of medication per dose.
-
maxDosePerPeriod¶ Upper limit on medication per unit of time.
-
maxDosePerAdministration¶ Upper limit on medication per administration.
-
maxDosePerLifetime¶ Upper limit on medication per lifetime of the patient.
-
rateRatio¶ Amount of medication per unit of time.
-
rateRange¶ Amount of medication per unit of time.
-
rateSimpleQuantity¶ Amount of medication per unit of time.
-
-
class
cardea.fhir.Duration(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA length of time.
-
class
cardea.fhir.Element(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseBase definition for all elements in a resource.
-
id¶ unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
-
extension¶ May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
-
-
class
cardea.fhir.ElementDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
path¶ The path identifies the element and is expressed as a “.”-separated list of ancestor elements, beginning with the name of the resource or extension.
-
representation¶ Codes that define how this element is represented in instances, when the deviation varies from the normal case.
-
sliceName¶ The name of this element definition slice, when slicing is working. The name must be a token with no dots or spaces. This is a unique name referring to a specific set of constraints applied to this element, used to provide a name to different slices of the same element.
-
label¶ A single preferred label which is the text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form.
-
code¶ A code that has the same meaning as the element in a particular terminology.
-
slicing¶ Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).
-
short¶ A concise description of what this element means (e.g. for use in autogenerated summaries).
-
definition¶ Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource.
-
comment¶ Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc.
-
requirements¶ This element is for traceability of why the element was created and why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this element.
-
alias¶ Identifies additional names by which this element might also be known.
-
min¶ The minimum number of times this element SHALL appear in the instance.
-
max¶ The maximum number of times this element is permitted to appear in the instance.
-
base¶ Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. This information is provided when the element definition is not the original definition of an element - i.g. either in a constraint on another type, or for elements from a super type in a snap shot.
-
contentReference¶ Identifies the identity of an element defined elsewhere in the profile whose content rules should be applied to the current element.
-
type¶ The data type or resource that the value of this element is permitted to be.
-
defaultValueBoolean¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueInteger¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueDecimal¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueBase64Binary¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueInstant¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueString¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueUri¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueDate¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueDateTime¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueTime¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueCode¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueOid¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueUuid¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueId¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueUnsignedInt¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValuePositiveInt¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueMarkdown¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueElement¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueExtension¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueBackboneElement¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueNarrative¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueAnnotation¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueAttachment¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueIdentifier¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueCodeableConcept¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueCoding¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueQuantity¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueDuration¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueSimpleQuantity¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueDistance¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueCount¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueMoney¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueAge¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueRange¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValuePeriod¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueRatio¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueReference¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueSampledData¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueSignature¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueHumanName¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueAddress¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueContactPoint¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueTiming¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueMeta¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueElementDefinition¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueContactDetail¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueContributor¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueDosage¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueRelatedArtifact¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueUsageContext¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueDataRequirement¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueParameterDefinition¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
defaultValueTriggerDefinition¶ The value that should be used if there is no value stated in the instance (e.g. ‘if not otherwise specified, the abstract is false’).
-
meaningWhenMissing¶ The Implicit meaning that is to be understood when this element is missing (e.g. ‘when this element is missing, the period is ongoing’.
-
orderMeaning¶ If present, indicates that the order of the repeating element has meaning and describes what that meaning is. If absent, it means that the order of the element has no meaning.
-
fixedBoolean¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedInteger¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedDecimal¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedBase64Binary¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedInstant¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedString¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedUri¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedDate¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedDateTime¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedTime¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedCode¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedOid¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedUuid¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedId¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedUnsignedInt¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedPositiveInt¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedMarkdown¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedElement¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedExtension¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedBackboneElement¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedNarrative¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedAnnotation¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedAttachment¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedIdentifier¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedCodeableConcept¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedCoding¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedQuantity¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedDuration¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedSimpleQuantity¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedDistance¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedCount¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedMoney¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedAge¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedRange¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedPeriod¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedRatio¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedReference¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedSampledData¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedSignature¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedHumanName¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedAddress¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedContactPoint¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedTiming¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedMeta¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedElementDefinition¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedContactDetail¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedContributor¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedDosage¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedRelatedArtifact¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedUsageContext¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedDataRequirement¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedParameterDefinition¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
fixedTriggerDefinition¶ Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
-
patternBoolean¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternInteger¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternDecimal¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternBase64Binary¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternInstant¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternString¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternUri¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternDate¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternDateTime¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternTime¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternCode¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternOid¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternUuid¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternId¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternUnsignedInt¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternPositiveInt¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternMarkdown¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternElement¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternExtension¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternBackboneElement¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternNarrative¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternAnnotation¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternAttachment¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternIdentifier¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternCodeableConcept¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternCoding¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternQuantity¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternDuration¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternSimpleQuantity¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternDistance¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternCount¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternMoney¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternAge¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternRange¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternPeriod¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternRatio¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternReference¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternSampledData¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternSignature¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternHumanName¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternAddress¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternContactPoint¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternTiming¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternMeta¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternElementDefinition¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternContactDetail¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternContributor¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternDosage¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternRelatedArtifact¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternUsageContext¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternDataRequirement¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternParameterDefinition¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
patternTriggerDefinition¶ Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
-
example¶ A sample value for this element demonstrating the type of information that would typically be found in the element.
-
minValueDate¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValueDateTime¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValueInstant¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValueTime¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValueDecimal¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValueInteger¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValuePositiveInt¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValueUnsignedInt¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
minValueQuantity¶ The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueDate¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueDateTime¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueInstant¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueTime¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueDecimal¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueInteger¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValuePositiveInt¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueUnsignedInt¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxValueQuantity¶ The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
-
maxLength¶ Indicates the maximum length in characters that is permitted to be present in conformant instances and which is expected to be supported by conformant consumers that support the element.
-
condition¶ A reference to an invariant that may make additional statements about the cardinality or value in the instance.
-
constraint¶ Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.
-
mustSupport¶ If true, implementations that produce or consume resources SHALL provide “support” for the element in some meaningful way. If false, the element may be ignored and not supported.
-
isModifier¶ If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.
-
isSummary¶ Whether the element should be included if a client requests a search with the parameter _summary=true.
-
binding¶ Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).
-
mapping¶ Identifies a concept from an external specification that roughly corresponds to this element.
-
-
class
cardea.fhir.ElementDefinition_Slicing(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
discriminator¶ Designates which child elements are used to discriminate between the slices when processing an instance. If one or more discriminators are provided, the value of the child elements in the instance data SHALL completely distinguish which slice the element in the resource matches based on the allowed values for those elements in each of the slices.
-
description¶ A human-readable text description of how the slicing works. If there is no discriminator, this is required to be present to provide whatever information is possible about how the slices can be differentiated.
-
ordered¶ If the matching elements have to occur in the same order as defined in the profile.
-
rules¶ Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.
-
-
class
cardea.fhir.ElementDefinition_Discriminator(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
type¶ How the element value is interpreted when discrimination is evaluated.
-
path¶ A FHIRPath expression, using a restricted subset of FHIRPath, that is used to identify the element on which discrimination is based.
-
-
class
cardea.fhir.ElementDefinition_Base(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
path¶ The Path that identifies the base element - this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element - that is, an element definition on a [[[StructureDefinition]]] without a StructureDefinition.base.
-
min¶ Minimum cardinality of the base element identified by the path.
-
max¶ Maximum cardinality of the base element identified by the path.
-
-
class
cardea.fhir.ElementDefinition_Type(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
code¶ URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. “string” is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.
-
profile¶ Identifies a profile structure or implementation Guide that SHALL hold for the datatype this element refers to. Can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide.
-
targetProfile¶ Identifies a profile structure or implementation Guide that SHALL hold for the target of the reference this element refers to. Can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide.
-
aggregation¶ If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.
-
versioning¶ Whether this reference needs to be version specific or version independent, or whether either can be used.
-
-
class
cardea.fhir.ElementDefinition_Example(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
label¶ Describes the purpose of this example amoung the set of examples.
-
valueBoolean¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueInteger¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueDecimal¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueBase64Binary¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueInstant¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueString¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueUri¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueDate¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueDateTime¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueTime¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueCode¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueOid¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueUuid¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueId¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueUnsignedInt¶ The actual value for the element, which must be one of the types allowed for this element.
-
valuePositiveInt¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueMarkdown¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueElement¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueExtension¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueBackboneElement¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueNarrative¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueAnnotation¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueAttachment¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueIdentifier¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueCodeableConcept¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueCoding¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueQuantity¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueDuration¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueSimpleQuantity¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueDistance¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueCount¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueMoney¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueAge¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueRange¶ The actual value for the element, which must be one of the types allowed for this element.
-
valuePeriod¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueRatio¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueReference¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueSampledData¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueSignature¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueHumanName¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueAddress¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueContactPoint¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueTiming¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueMeta¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueElementDefinition¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueContactDetail¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueContributor¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueDosage¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueRelatedArtifact¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueUsageContext¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueDataRequirement¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueParameterDefinition¶ The actual value for the element, which must be one of the types allowed for this element.
-
valueTriggerDefinition¶ The actual value for the element, which must be one of the types allowed for this element.
-
-
class
cardea.fhir.ElementDefinition_Constraint(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
key¶ Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.
-
requirements¶ Description of why this constraint is necessary or appropriate.
-
severity¶ Identifies the impact constraint violation has on the conformance of the instance.
-
human¶ Text that can be used to describe the constraint in messages identifying that the constraint has been violated.
-
expression¶ A [FHIRPath](http://hl7.org/fluentpath) expression of constraint that can be executed to see if this constraint is met.
-
xpath¶ An XPath expression of constraint that can be executed to see if this constraint is met.
-
source¶ A reference to the original source of the constraint, for traceability purposes.
-
-
class
cardea.fhir.ElementDefinition_Binding(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
strength¶ Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.
-
description¶ Describes the intended use of this particular set of codes.
-
valueSetUri¶ Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used. If the binding refers to an explicit value set - the normal case - then use a Reference(ValueSet) preferably containing the canonical URL for the value set. If the reference is to an implicit value set - usually, an IETF RFC that defines a grammar, such as mime types - then use a uri.
-
valueSetReference¶ Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used. If the binding refers to an explicit value set - the normal case - then use a Reference(ValueSet) preferably containing the canonical URL for the value set. If the reference is to an implicit value set - usually, an IETF RFC that defines a grammar, such as mime types - then use a uri.
-
-
class
cardea.fhir.ElementDefinition_Mapping(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseCaptures constraints on each element within the resource, profile, or extension.
-
identity¶ An internal reference to the definition of a mapping.
-
language¶ Identifies the computable language in which mapping.map is expressed.
-
map¶ Expresses what part of the target specification corresponds to this element.
-
comment¶ Comments that provide information about the mapping or its use.
-
-
class
cardea.fhir.EligibilityRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe EligibilityRequest provides patient and insurance coverage information to an insurer for them to respond, in the form of an EligibilityResponse, with information regarding whether the stated coverage is valid and in-force and optionally to provide the insurance details of the policy.
-
resourceType¶ This is a EligibilityRequest resource
-
identifier¶ The Response business identifier.
-
status¶ The status of the resource instance.
-
priority¶ Immediate (STAT), best effort (NORMAL), deferred (DEFER).
-
patient¶ Patient Resource.
-
servicedDate¶ The date or dates when the enclosed suite of services were performed or completed.
-
servicedPeriod¶ The date or dates when the enclosed suite of services were performed or completed.
-
created¶ The date when this resource was created.
-
enterer¶ Person who created the invoice/claim/pre-determination or pre-authorization.
-
provider¶ The practitioner who is responsible for the services rendered to the patient.
-
organization¶ The organization which is responsible for the services rendered to the patient.
-
insurer¶ The Insurer who is target of the request.
-
facility¶ Facility where the services were provided.
-
coverage¶ Financial instrument by which payment information for health care.
-
businessArrangement¶ The contract number of a business agreement which describes the terms and conditions.
-
benefitCategory¶ Dental, Vision, Medical, Pharmacy, Rehab etc.
-
benefitSubCategory¶ Dental: basic, major, ortho; Vision exam, glasses, contacts; etc.
-
-
class
cardea.fhir.EligibilityResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides eligibility and plan details from the processing of an Eligibility resource.
-
resourceType¶ This is a EligibilityResponse resource
-
identifier¶ The Response business identifier.
-
status¶ The status of the resource instance.
-
created¶ The date when the enclosed suite of services were performed or completed.
-
requestProvider¶ The practitioner who is responsible for the services rendered to the patient.
-
requestOrganization¶ The organization which is responsible for the services rendered to the patient.
-
request¶ Original request resource reference.
-
outcome¶ Transaction status: error, complete.
-
disposition¶ A description of the status of the adjudication.
-
insurer¶ The Insurer who produced this adjudicated response.
-
inforce¶ Flag indicating if the coverage provided is inforce currently if no service date(s) specified or for the whole duration of the service dates.
-
insurance¶ The insurer may provide both the details for the requested coverage as well as details for additional coverages known to the insurer.
-
form¶ The form to be used for printing the content.
-
error¶ Mutually exclusive with Services Provided (Item).
-
-
class
cardea.fhir.EligibilityResponse_Insurance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides eligibility and plan details from the processing of an Eligibility resource.
-
coverage¶ A suite of updated or additional Coverages from the Insurer.
-
contract¶ The contract resource which may provide more detailed information.
-
benefitBalance¶ Benefits and optionally current balances by Category.
-
-
class
cardea.fhir.EligibilityResponse_BenefitBalance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides eligibility and plan details from the processing of an Eligibility resource.
-
category¶ Dental, Vision, Medical, Pharmacy, Rehab etc.
-
subCategory¶ Dental: basic, major, ortho; Vision exam, glasses, contacts; etc.
-
excluded¶ True if the indicated class of service is excluded from the plan, missing or False indicated the service is included in the coverage.
-
name¶ A short name or tag for the benefit, for example MED01, or DENT2.
-
description¶ A richer description of the benefit, for example ‘DENT2 covers 100% of basic, 50% of major but exclused Ortho, Implants and Costmetic services’.
-
network¶ Network designation.
-
unit¶ Unit designation: individual or family.
-
term¶ The term or period of the values such as ‘maximum lifetime benefit’ or ‘maximum annual vistis’.
-
financial¶ Benefits Used to date.
-
-
class
cardea.fhir.EligibilityResponse_Financial(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides eligibility and plan details from the processing of an Eligibility resource.
-
type¶ Deductable, visits, benefit amount.
-
allowedUnsignedInt¶ Benefits allowed.
-
allowedString¶ Benefits allowed.
-
allowedMoney¶ Benefits allowed.
-
usedUnsignedInt¶ Benefits used.
-
usedMoney¶ Benefits used.
-
-
class
cardea.fhir.EligibilityResponse_Error(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides eligibility and plan details from the processing of an Eligibility resource.
-
code¶ An error code,from a specified code system, which details why the eligibility check could not be performed.
-
-
class
cardea.fhir.Encounter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
-
resourceType¶ This is a Encounter resource
-
identifier¶ Identifier(s) by which this encounter is known.
-
status¶ planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
-
statusHistory¶ The status history permits the encounter resource to contain the status history without needing to read through the historical versions of the resource, or even have the server store them.
-
class¶ inpatient | outpatient | ambulatory | emergency +.
-
classHistory¶ The class history permits the tracking of the encounters transitions without needing to go through the resource history. This would be used for a case where an admission starts of as an emergency encounter, then transisions into an inpatient scenario. Doing this and not restarting a new encounter ensures that any lab/diagnostic results can more easily follow the patient and not require re-processing and not get lost or cancelled during a kindof discharge from emergency to inpatient.
-
type¶ Specific type of encounter (e.g. e-mail consultation, surgical day-care, skilled nursing, rehabilitation).
-
priority¶ Indicates the urgency of the encounter.
-
subject¶ The patient ro group present at the encounter.
-
episodeOfCare¶ Where a specific encounter should be classified as a part of a specific episode(s) of care this field should be used. This association can facilitate grouping of related encounters together for a specific purpose, such as government reporting, issue tracking, association via a common problem. The association is recorded on the encounter as these are typically created after the episode of care, and grouped on entry rather than editing the episode of care to append another encounter to it (the episode of care could span years).
-
incomingReferral¶ The referral request this encounter satisfies (incoming referral).
-
participant¶ The list of people responsible for providing the service.
-
appointment¶ The appointment that scheduled this encounter.
-
period¶ The start and end time of the encounter.
-
length¶ Quantity of time the encounter lasted. This excludes the time during leaves of absence.
-
reason¶ Reason the encounter takes place, expressed as a code. For admissions, this can be used for a coded admission diagnosis.
-
diagnosis¶ The list of diagnosis relevant to this encounter.
-
account¶ The set of accounts that may be used for billing for this Encounter.
-
hospitalization¶ Details about the admission to a healthcare service.
-
location¶ List of locations where the patient has been during this encounter.
-
serviceProvider¶ An organization that is in charge of maintaining the information of this Encounter (e.g. who maintains the report or the master service catalog item, etc.). This MAY be the same as the organization on the Patient record, however it could be different. This MAY not be not the Service Delivery Location’s Organization.
-
partOf¶ Another Encounter of which this encounter is a part of (administratively or in time).
-
-
class
cardea.fhir.Encounter_StatusHistory(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
-
status¶ planned | arrived | triaged | in-progress | onleave | finished | cancelled +.
-
period¶ The time that the episode was in the specified status.
-
-
class
cardea.fhir.Encounter_ClassHistory(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
-
class¶ inpatient | outpatient | ambulatory | emergency +.
-
period¶ The time that the episode was in the specified class.
-
-
class
cardea.fhir.Encounter_Participant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
-
type¶ Role of participant in encounter.
-
period¶ The period of time that the specified participant participated in the encounter. These can overlap or be sub-sets of the overall encounter’s period.
-
individual¶ Persons involved in the encounter other than the patient.
-
-
class
cardea.fhir.Encounter_Diagnosis(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
-
condition¶ Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure.
-
role¶ Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …).
-
rank¶ Ranking of the diagnosis (for each role type).
-
-
class
cardea.fhir.Encounter_Hospitalization(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
-
preAdmissionIdentifier¶ Pre-admission identifier.
-
origin¶ The location from which the patient came before admission.
-
admitSource¶ From where patient was admitted (physician referral, transfer).
-
reAdmission¶ Whether this hospitalization is a readmission and why if known.
-
dietPreference¶ Diet preferences reported by the patient.
-
specialCourtesy¶ Special courtesies (VIP, board member).
-
specialArrangement¶ Any special requests that have been made for this hospitalization encounter, such as the provision of specific equipment or other things.
-
destination¶ Location to which the patient is discharged.
-
dischargeDisposition¶ Category or kind of location after discharge.
-
-
class
cardea.fhir.Encounter_Location(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
-
location¶ The location where the encounter takes place.
-
status¶ The status of the participants’ presence at the specified location during the period specified. If the participant is is no longer at the location, then the period will have an end date/time.
-
period¶ Time period during which the patient was present at the location.
-
-
class
cardea.fhir.Endpoint(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.
-
resourceType¶ This is a Endpoint resource
-
identifier¶ Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
-
status¶ active | suspended | error | off | test.
-
connectionType¶ A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
-
name¶ A friendly name that this endpoint can be referred to with.
-
managingOrganization¶ The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).
-
contact¶ Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
-
period¶ The interval during which the endpoint is expected to be operational.
-
payloadType¶ The payload type describes the acceptable content that can be communicated on the endpoint.
-
payloadMimeType¶ The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
-
address¶ The uri that describes the actual end-point to connect to.
-
header¶ Additional headers / information to send as part of the notification.
-
-
class
cardea.fhir.EnrollmentRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the insurance enrollment details to the insurer regarding a specified coverage.
-
resourceType¶ This is a EnrollmentRequest resource
-
identifier¶ The Response business identifier.
-
status¶ The status of the resource instance.
-
created¶ The date when this resource was created.
-
insurer¶ The Insurer who is target of the request.
-
provider¶ The practitioner who is responsible for the services rendered to the patient.
-
organization¶ The organization which is responsible for the services rendered to the patient.
-
subject¶ Patient Resource.
-
coverage¶ Reference to the program or plan identification, underwriter or payor.
-
-
class
cardea.fhir.EnrollmentResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides enrollment and plan details from the processing of an Enrollment resource.
-
resourceType¶ This is a EnrollmentResponse resource
-
identifier¶ The Response business identifier.
-
status¶ The status of the resource instance.
-
request¶ Original request resource reference.
-
outcome¶ Processing status: error, complete.
-
disposition¶ A description of the status of the adjudication.
-
created¶ The date when the enclosed suite of services were performed or completed.
-
organization¶ The Insurer who produced this adjudicated response.
-
requestProvider¶ The practitioner who is responsible for the services rendered to the patient.
-
requestOrganization¶ The organization which is responsible for the services rendered to the patient.
-
-
class
cardea.fhir.EpisodeOfCare(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
-
resourceType¶ This is a EpisodeOfCare resource
-
identifier¶ The EpisodeOfCare may be known by different identifiers for different contexts of use, such as when an external agency is tracking the Episode for funding purposes.
-
status¶ planned | waitlist | active | onhold | finished | cancelled.
-
statusHistory¶ The history of statuses that the EpisodeOfCare has been through (without requiring processing the history of the resource).
-
type¶ A classification of the type of episode of care; e.g. specialist referral, disease management, type of funded care.
-
diagnosis¶ The list of diagnosis relevant to this episode of care.
-
patient¶ The patient who is the focus of this episode of care.
-
managingOrganization¶ The organization that has assumed the specific responsibilities for the specified duration.
-
period¶ The interval during which the managing organization assumes the defined responsibility.
-
referralRequest¶ Referral Request(s) that are fulfilled by this EpisodeOfCare, incoming referrals.
-
careManager¶ The practitioner that is the care manager/care co-ordinator for this patient.
-
team¶ The list of practitioners that may be facilitating this episode of care for specific purposes.
-
account¶ The set of accounts that may be used for billing for this EpisodeOfCare.
-
-
class
cardea.fhir.EpisodeOfCare_StatusHistory(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
-
status¶ planned | waitlist | active | onhold | finished | cancelled.
-
period¶ The period during this EpisodeOfCare that the specific status applied.
-
-
class
cardea.fhir.EpisodeOfCare_Diagnosis(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time.
-
condition¶ A list of conditions/problems/diagnoses that this episode of care is intended to be providing care for.
-
role¶ Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …).
-
rank¶ Ranking of the diagnosis (for each role type).
-
-
class
cardea.fhir.ExpansionProfile(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
resourceType¶ This is a ExpansionProfile resource
-
url¶ An absolute URI that is used to identify this expansion profile when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this expansion profile is (or will be) published. The URL SHOULD include the major version of the expansion profile. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this expansion profile when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the expansion profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the expansion profile author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the expansion profile. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
status¶ The status of this expansion profile. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this expansion profile is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the expansion profile was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the expansion profile changes.
-
publisher¶ The name of the individual or organization that published the expansion profile.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the expansion profile from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate expansion profile instances.
-
jurisdiction¶ A legal or geographic region in which the expansion profile is intended to be used.
-
fixedVersion¶ Fix use of a particular code system to a particular version.
-
excludedSystem¶ Code system, or a particular version of a code system to be excluded from value set expansions.
-
includeDesignations¶ Controls whether concept designations are to be included or excluded in value set expansions.
-
designation¶ A set of criteria that provide the constraints imposed on the value set expansion by including or excluding designations.
-
includeDefinition¶ Controls whether the value set definition is included or excluded in value set expansions.
-
activeOnly¶ Controls whether inactive concepts are included or excluded in value set expansions.
-
excludeNested¶ Controls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains).
-
excludeNotForUI¶ Controls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.
-
excludePostCoordinated¶ Controls whether or not the value set expansion includes post coordinated codes.
-
displayLanguage¶ Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.
-
limitedExpansion¶ If the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete, using the extension [http://hl7.org/fhir/StructureDefinition/valueset-toocostly](extension-valueset-toocostly.html).
-
-
class
cardea.fhir.ExpansionProfile_FixedVersion(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
system¶ The specific system for which to fix the version.
-
version¶ The version of the code system from which codes in the expansion should be included.
-
mode¶ How to manage the intersection between a fixed version in a value set, and this fixed version of the system in the expansion profile.
-
-
class
cardea.fhir.ExpansionProfile_ExcludedSystem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
system¶ An absolute URI which is the code system to be excluded.
-
version¶ The version of the code system from which codes in the expansion should be excluded.
-
-
class
cardea.fhir.ExpansionProfile_Designation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
include¶ Designations to be included.
-
exclude¶ Designations to be excluded.
-
-
class
cardea.fhir.ExpansionProfile_Include(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
designation¶ A data group for each designation to be included.
-
-
class
cardea.fhir.ExpansionProfile_Designation1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
language¶ The language this designation is defined for.
-
use¶ Which kinds of designation to include in the expansion.
-
-
class
cardea.fhir.ExpansionProfile_Exclude(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
designation¶ A data group for each designation to be excluded.
-
-
class
cardea.fhir.ExpansionProfile_Designation2(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseResource to define constraints on the Expansion of a FHIR ValueSet.
-
language¶ The language this designation is defined for.
-
use¶ Which kinds of designation to exclude from the expansion.
-
-
class
cardea.fhir.ExplanationOfBenefit(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
resourceType¶ This is a ExplanationOfBenefit resource
-
identifier¶ The EOB Business Identifier.
-
status¶ The status of the resource instance.
-
type¶ The category of claim, eg, oral, pharmacy, vision, insitutional, professional.
-
subType¶ A finer grained suite of claim subtype codes which may convey Inpatient vs Outpatient and/or a specialty service. In the US the BillType.
-
patient¶ Patient Resource.
-
billablePeriod¶ The billable period for which charges are being submitted.
-
created¶ The date when the EOB was created.
-
enterer¶ The person who created the explanation of benefit.
-
insurer¶ The insurer which is responsible for the explanation of benefit.
-
provider¶ The provider which is responsible for the claim.
-
organization¶ The provider which is responsible for the claim.
-
referral¶ The referral resource which lists the date, practitioner, reason and other supporting information.
-
facility¶ Facility where the services were provided.
-
claim¶ The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number.
-
claimResponse¶ The business identifier for the instance: invoice number, claim number, pre-determination or pre-authorization number.
-
outcome¶ Processing outcome errror, partial or complete processing.
-
disposition¶ A description of the status of the adjudication.
Other claims which are related to this claim such as prior claim versions or for related services.
-
prescription¶ Prescription to support the dispensing of Pharmacy or Vision products.
-
originalPrescription¶ Original prescription which has been superceded by this prescription to support the dispensing of pharmacy services, medications or products. For example, a physician may prescribe a medication which the pharmacy determines is contraindicated, or for which the patient has an intolerance, and therefor issues a new precription for an alternate medication which has the same theraputic intent. The prescription from the pharmacy becomes the ‘prescription’ and that from the physician becomes the ‘original prescription’.
-
payee¶ The party to be reimbursed for the services.
-
information¶ Additional information codes regarding exceptions, special considerations, the condition, situation, prior or concurrent issues. Often there are mutiple jurisdiction specific valuesets which are required.
-
careTeam¶ The members of the team who provided the overall service as well as their role and whether responsible and qualifications.
-
diagnosis¶ Ordered list of patient diagnosis for which care is sought.
-
procedure¶ Ordered list of patient procedures performed to support the adjudication.
-
precedence¶ Precedence (primary, secondary, etc.).
-
insurance¶ Financial instrument by which payment information for health care.
-
accident¶ An accident which resulted in the need for healthcare services.
-
employmentImpacted¶ The start and optional end dates of when the patient was precluded from working due to the treatable condition(s).
-
hospitalization¶ The start and optional end dates of when the patient was confined to a treatment center.
-
item¶ First tier of goods and services.
-
addItem¶ The first tier service adjudications for payor added services.
-
totalCost¶ The total cost of the services reported.
-
unallocDeductable¶ The amount of deductable applied which was not allocated to any particular service line.
-
totalBenefit¶ Total amount of benefit payable (Equal to sum of the Benefit amounts from all detail lines and additions less the Unallocated Deductable).
-
payment¶ Payment details for the claim if the claim has been paid.
-
form¶ The form to be used for printing the content.
-
processNote¶ Note text.
-
benefitBalance¶ Balance by Benefit Category.
-
-
class
cardea.fhir.ExplanationOfBenefit_Related(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
claim¶ Other claims which are related to this claim such as prior claim versions or for related services.
-
relationship¶ For example prior or umbrella.
-
reference¶ An alternate organizational reference to the case or file to which this particular claim pertains - eg Property/Casualy insurer claim # or Workers Compensation case # .
-
-
class
cardea.fhir.ExplanationOfBenefit_Payee(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
type¶ Type of Party to be reimbursed: Subscriber, provider, other.
-
resourceType¶ organization | patient | practitioner | relatedperson.
-
party¶ Party to be reimbursed: Subscriber, provider, other.
-
-
class
cardea.fhir.ExplanationOfBenefit_Information(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequence¶ Sequence of the information element which serves to provide a link.
-
category¶ The general class of the information supplied: information; exception; accident, employment; onset, etc.
-
code¶ System and code pertaining to the specific information regarding special conditions relating to the setting, treatment or patient for which care is sought which may influence the adjudication.
-
timingDate¶ The date when or period to which this information refers.
-
timingPeriod¶ The date when or period to which this information refers.
-
valueString¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
valueQuantity¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
valueAttachment¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
valueReference¶ Additional data or information such as resources, documents, images etc. including references to the data or the actual inclusion of the data.
-
reason¶ For example, provides the reason for: the additional stay, or missing tooth or any other situation where a reason code is required in addition to the content.
-
-
class
cardea.fhir.ExplanationOfBenefit_CareTeam(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequence¶ Sequence of careteam which serves to order and provide a link.
-
provider¶ The members of the team who provided the overall service.
-
responsible¶ The practitioner who is billing and responsible for the claimed services rendered to the patient.
-
role¶ The lead, assisting or supervising practitioner and their discipline if a multidisiplinary team.
-
qualification¶ The qualification which is applicable for this service.
-
-
class
cardea.fhir.ExplanationOfBenefit_Diagnosis(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequence¶ Sequence of diagnosis which serves to provide a link.
-
diagnosisCodeableConcept¶ The diagnosis.
-
diagnosisReference¶ The diagnosis.
-
type¶ The type of the Diagnosis, for example: admitting, primary, secondary, discharge.
-
packageCode¶ The package billing code, for example DRG, based on the assigned grouping code system.
-
-
class
cardea.fhir.ExplanationOfBenefit_Procedure(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequence¶ Sequence of procedures which serves to order and provide a link.
-
date¶ Date and optionally time the procedure was performed .
-
procedureCodeableConcept¶ The procedure code.
-
procedureReference¶ The procedure code.
-
-
class
cardea.fhir.ExplanationOfBenefit_Insurance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
coverage¶ Reference to the program or plan identification, underwriter or payor.
-
preAuthRef¶ A list of references from the Insurer to which these services pertain.
-
-
class
cardea.fhir.ExplanationOfBenefit_Accident(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
date¶ Date of an accident which these services are addressing.
-
type¶ Type of accident: work, auto, etc.
-
locationAddress¶ Where the accident occurred.
-
locationReference¶ Where the accident occurred.
-
-
class
cardea.fhir.ExplanationOfBenefit_Item(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequence¶ A service line number.
-
careTeamLinkId¶ Careteam applicable for this service or product line.
-
diagnosisLinkId¶ Diagnosis applicable for this service or product line.
-
procedureLinkId¶ Procedures applicable for this service or product line.
-
informationLinkId¶ Exceptions, special conditions and supporting information pplicable for this service or product line.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. ‘glasses’ or ‘compound’.
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
programCode¶ For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.
-
servicedDate¶ The date or dates when the enclosed suite of services were performed or completed.
-
servicedPeriod¶ The date or dates when the enclosed suite of services were performed or completed.
-
locationCodeableConcept¶ Where the service was provided.
-
locationAddress¶ Where the service was provided.
-
locationReference¶ Where the service was provided.
-
quantity¶ The number of repetitions of a service or product.
-
unitPrice¶ If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.
-
factor¶ A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
net¶ The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
udi¶ List of Unique Device Identifiers associated with this line item.
-
bodySite¶ Physical service site on the patient (limb, tooth, etc).
-
subSite¶ A region or surface of the site, eg. limb region or tooth surface(s).
-
encounter¶ A billed item may include goods or services provided in multiple encounters.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
detail¶ Second tier of goods and services.
-
-
class
cardea.fhir.ExplanationOfBenefit_Adjudication(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
category¶ Code indicating: Co-Pay, deductable, elegible, benefit, tax, etc.
-
reason¶ Adjudication reason such as limit reached.
-
amount¶ Monitory amount associated with the code.
-
value¶ A non-monetary value for example a percentage. Mutually exclusive to the amount element above.
-
-
class
cardea.fhir.ExplanationOfBenefit_Detail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequence¶ A service line number.
-
type¶ The type of product or service.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. ‘glasses’ or ‘compound’.
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
programCode¶ For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.
-
quantity¶ The number of repetitions of a service or product.
-
unitPrice¶ If the item is a node then this is the fee for the product or service, otherwise this is the total of the fees for the children of the group.
-
factor¶ A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
net¶ The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
udi¶ List of Unique Device Identifiers associated with this line item.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
subDetail¶ Third tier of goods and services.
-
-
class
cardea.fhir.ExplanationOfBenefit_SubDetail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequence¶ A service line number.
-
type¶ The type of product or service.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI).
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
programCode¶ For programs which require reson codes for the inclusion, covering, of this billed item under the program or sub-program.
-
quantity¶ The number of repetitions of a service or product.
-
unitPrice¶ The fee for an addittional service or product or charge.
-
factor¶ A real number that represents a multiplier used in determining the overall value of services delivered and/or goods received. The concept of a Factor allows for a discount or surcharge multiplier to be applied to a monetary amount.
-
net¶ The quantity times the unit price for an addittional service or product or charge. For example, the formula: unit Quantity * unit Price (Cost per Point) * factor Number * points = net Amount. Quantity, factor and points are assumed to be 1 if not supplied.
-
udi¶ List of Unique Device Identifiers associated with this line item.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
-
class
cardea.fhir.ExplanationOfBenefit_AddItem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
sequenceLinkId¶ List of input service items which this service line is intended to replace.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ If this is an actual service or product line, ie. not a Group, then use code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI). If a grouping item then use a group code to indicate the type of thing being grouped eg. ‘glasses’ or ‘compound’.
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
fee¶ The fee charged for the professional service or product.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
detail¶ The second tier service adjudications for payor added services.
-
-
class
cardea.fhir.ExplanationOfBenefit_Detail1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
revenue¶ The type of reveneu or cost center providing the product and/or service.
-
category¶ Health Care Service Type Codes to identify the classification of service or benefits.
-
service¶ A code to indicate the Professional Service or Product supplied (eg. CTP, HCPCS,USCLS,ICD10, NCPDP,DIN,ACHI,CCI).
-
modifier¶ Item typification or modifiers codes, eg for Oral whether the treatment is cosmetic or associated with TMJ, or for medical whether the treatment was outside the clinic or out of office hours.
-
fee¶ The fee charged for the professional service or product.
-
noteNumber¶ A list of note references to the notes provided below.
-
adjudication¶ The adjudications results.
-
-
class
cardea.fhir.ExplanationOfBenefit_Payment(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
type¶ Whether this represents partial or complete payment of the claim.
-
adjustment¶ Adjustment to the payment of this transaction which is not related to adjudication of this transaction.
-
adjustmentReason¶ Reason for the payment adjustment.
-
date¶ Estimated payment date.
-
amount¶ Payable less any payment adjustment.
-
identifier¶ Payment identifer.
-
-
class
cardea.fhir.ExplanationOfBenefit_ProcessNote(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
number¶ An integer associated with each note which may be referred to from each service line item.
-
type¶ The note purpose: Print/Display.
-
text¶ The note text.
-
language¶ The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. “en” for English, or “en-US” for American English versus “en-EN” for England English.
-
-
class
cardea.fhir.ExplanationOfBenefit_BenefitBalance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
category¶ Dental, Vision, Medical, Pharmacy, Rehab etc.
-
subCategory¶ Dental: basic, major, ortho; Vision exam, glasses, contacts; etc.
-
excluded¶ True if the indicated class of service is excluded from the plan, missing or False indicated the service is included in the coverage.
-
name¶ A short name or tag for the benefit, for example MED01, or DENT2.
-
description¶ A richer description of the benefit, for example ‘DENT2 covers 100% of basic, 50% of major but exclused Ortho, Implants and Costmetic services’.
-
network¶ Network designation.
-
unit¶ Unit designation: individual or family.
-
term¶ The term or period of the values such as ‘maximum lifetime benefit’ or ‘maximum annual vistis’.
-
financial¶ Benefits Used to date.
-
-
class
cardea.fhir.ExplanationOfBenefit_Financial(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided.
-
type¶ Deductable, visits, benefit amount.
-
allowedUnsignedInt¶ Benefits allowed.
-
allowedString¶ Benefits allowed.
-
allowedMoney¶ Benefits allowed.
-
usedUnsignedInt¶ Benefits used.
-
usedMoney¶ Benefits used.
-
-
class
cardea.fhir.Extension(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseOptional Extension Element - found in all resources.
-
url¶ Source of the definition for the extension code - a logical name or a URL.
-
valueBoolean¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueInteger¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueDecimal¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueBase64Binary¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueInstant¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueString¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueUri¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueDate¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueDateTime¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueTime¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueCode¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueOid¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueUuid¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueId¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueUnsignedInt¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valuePositiveInt¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueMarkdown¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueElement¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueExtension¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueBackboneElement¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueNarrative¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueAnnotation¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueAttachment¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueIdentifier¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueCodeableConcept¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueCoding¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueQuantity¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueDuration¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueSimpleQuantity¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueDistance¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueCount¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueMoney¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueAge¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueRange¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valuePeriod¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueRatio¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueReference¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueSampledData¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueSignature¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueHumanName¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueAddress¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueContactPoint¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueTiming¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueMeta¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueElementDefinition¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueContactDetail¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueContributor¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueDosage¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueRelatedArtifact¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueUsageContext¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueDataRequirement¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueParameterDefinition¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
valueTriggerDefinition¶ Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).
-
-
class
cardea.fhir.FamilyMemberHistory(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseSignificant health events and conditions for a person related to the patient relevant in the context of care for the patient.
-
resourceType¶ This is a FamilyMemberHistory resource
-
identifier¶ This records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
definition¶ A protocol or questionnaire that was adhered to in whole or in part by this event.
-
status¶ A code specifying the status of the record of the family history of a specific family member.
-
notDone¶ If true, indicates the taking of an individual family member’s history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.
-
notDoneReason¶ Describes why the family member’s history is absent.
-
patient¶ The person who this history concerns.
-
date¶ The date (and possibly time) when the family member history was taken.
-
name¶ This will either be a name or a description; e.g. “Aunt Susan”, “my cousin with the red hair”.
-
relationship¶ The type of relationship this person has to the patient (father, mother, brother etc.).
-
gender¶ Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
-
bornPeriod¶ The actual or approximate date of birth of the relative.
-
bornDate¶ The actual or approximate date of birth of the relative.
-
bornString¶ The actual or approximate date of birth of the relative.
-
ageAge¶ The age of the relative at the time the family member history is recorded.
-
ageRange¶ The age of the relative at the time the family member history is recorded.
-
ageString¶ The age of the relative at the time the family member history is recorded.
-
estimatedAge¶ If true, indicates that the age value specified is an estimated value.
-
deceasedBoolean¶ Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
-
deceasedAge¶ Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
-
deceasedRange¶ Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
-
deceasedDate¶ Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
-
deceasedString¶ Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
-
reasonCode¶ Describes why the family member history occurred in coded or textual form.
-
reasonReference¶ Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
-
note¶ This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.
-
condition¶ The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.
-
-
class
cardea.fhir.FamilyMemberHistory_Condition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseSignificant health events and conditions for a person related to the patient relevant in the context of care for the patient.
-
code¶ The actual condition specified. Could be a coded condition (like MI or Diabetes) or a less specific string like ‘cancer’ depending on how much is known about the condition and the capabilities of the creating system.
-
outcome¶ Indicates what happened as a result of this condition. If the condition resulted in death, deceased date is captured on the relation.
-
onsetAge¶ Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
-
onsetRange¶ Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
-
onsetPeriod¶ Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
-
onsetString¶ Either the age of onset, range of approximate age or descriptive string can be recorded. For conditions with multiple occurrences, this describes the first known occurrence.
-
note¶ An area where general notes can be placed about this specific condition.
-
-
class
cardea.fhir.fhirbase[source]¶ Bases:
object-
assert_type()[source]¶ Checks class values follow set possible enumerations.
Raises: ValueError– An error occurs if an attribute of the fhir class does not match its possible enumerations.
-
get_dataframe()[source]¶ Returns dataframe from class attribute values.
Returns: A dataframe representation of the class.
-
get_eligible_relationships()[source]¶ Returns class relationships for attributes that are used.
Returns: A list of the class’s associated relationships after filtering out attributes that are not used.
-
get_id()[source]¶ Returns fhir class identifier.
Returns: The name of identifier of the fhir class. Raises: LookupError– An error occurs if fhir class doesn’t have an id.
-
-
class
cardea.fhir.Flag(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseProspective warnings of potential issues when providing care to the patient.
-
resourceType¶ This is a Flag resource
-
identifier¶ Identifier assigned to the flag for external use (outside the FHIR environment).
-
status¶ Supports basic workflow.
-
category¶ Allows an flag to be divided into different categories like clinical, administrative etc. Intended to be used as a means of filtering which flags are displayed to particular user or in a given context.
-
code¶ The coded value or textual component of the flag to display to the user.
-
subject¶ The patient, location, group , organization , or practitioner, etc. this is about record this flag is associated with.
-
period¶ The period of time from the activation of the flag to inactivation of the flag. If the flag is active, the end of the period should be unspecified.
-
encounter¶ This alert is only relevant during the encounter.
The person, organization or device that created the flag.
-
-
class
cardea.fhir.Goal(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
-
resourceType¶ This is a Goal resource
-
identifier¶ This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
status¶ Indicates whether the goal has been reached and is still considered relevant.
-
category¶ Indicates a category the goal falls within.
-
priority¶ Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
-
description¶ Human-readable and/or coded description of a specific desired objective of care, such as “control blood pressure” or “negotiate an obstacle course” or “dance with child at wedding”.
-
subject¶ Identifies the patient, group or organization for whom the goal is being established.
-
startDate¶ The date or event after which the goal should begin being pursued.
-
startCodeableConcept¶ The date or event after which the goal should begin being pursued.
-
target¶ Indicates what should be done by when.
-
statusDate¶ Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
-
statusReason¶ Captures the reason for the current status.
-
expressedBy¶ Indicates whose goal this is - patient goal, practitioner goal, etc.
-
addresses¶ The identified conditions and other health record elements that are intended to be addressed by the goal.
-
note¶ Any comments related to the goal.
-
outcomeCode¶ Identifies the change (or lack of change) at the point when the status of the goal is assessed.
-
outcomeReference¶ Details of what’s changed (or not changed).
-
-
class
cardea.fhir.Goal_Target(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
-
measure¶ The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
-
detailQuantity¶ The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
-
detailRange¶ The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
-
detailCodeableConcept¶ The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.
-
dueDate¶ Indicates either the date or the duration after start by which the goal should be met.
-
dueDuration¶ Indicates either the date or the duration after start by which the goal should be met.
-
-
class
cardea.fhir.GraphDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.
-
resourceType¶ This is a GraphDefinition resource
-
url¶ An absolute URI that is used to identify this graph definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this graph definition is (or will be) published. The URL SHOULD include the major version of the graph definition. For more information see [Technical and Business Versions](resource.html#versions).
-
version¶ The identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
status¶ The status of this graph definition. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the graph definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the graph definition changes.
-
publisher¶ The name of the individual or organization that published the graph definition.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the graph definition from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate graph definition instances.
-
jurisdiction¶ A legal or geographic region in which the graph definition is intended to be used.
-
purpose¶ Explaination of why this graph definition is needed and why it has been designed as it has.
-
start¶ The type of FHIR resource at which instances of this graph start.
-
profile¶ The profile that describes the use of the base resource.
-
link¶ Links this graph makes rules about.
-
-
class
cardea.fhir.GraphDefinition_Link(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.
-
path¶ Path in the resource that contains the link.
-
sliceName¶ Which slice (if profiled).
-
min¶ Minimum occurrences for this link.
-
max¶ Maximum occurrences for this link.
-
description¶ Information about why this link is of interest in this graph definition.
-
target¶ Potential target for the link.
-
-
class
cardea.fhir.GraphDefinition_Target(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.
-
type¶ Type of resource this link refers to.
-
profile¶ Profile for the target resource.
-
compartment¶ Compartment Consistency Rules.
-
link¶ Additional links from target resource.
-
-
class
cardea.fhir.GraphDefinition_Compartment(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.
-
code¶ Identifies the compartment.
-
rule¶ identical | matching | different | no-rule | custom.
-
expression¶ Custom rule, as a FHIRPath expression.
-
description¶ Documentation for FHIRPath expression.
-
-
class
cardea.fhir.Group(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized; i.e. a collection of entities that isn’t an Organization.
-
resourceType¶ This is a Group resource
-
identifier¶ A unique business identifier for this group.
-
active¶ Indicates whether the record for the group is available for use or is merely being retained for historical purposes.
-
type¶ Identifies the broad classification of the kind of resources the group includes.
-
actual¶ If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.
-
code¶ Provides a specific type of resource the group includes; e.g. “cow”, “syringe”, etc.
-
name¶ A label assigned to the group for human identification and communication.
-
quantity¶ A count of the number of resource instances that are part of the group.
-
characteristic¶ Identifies the traits shared by members of the group.
-
member¶ Identifies the resource instances that are members of the group.
-
-
class
cardea.fhir.Group_Characteristic(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized; i.e. a collection of entities that isn’t an Organization.
-
code¶ A code that identifies the kind of trait being asserted.
-
valueCodeableConcept¶ The value of the trait that holds (or does not hold - see ‘exclude’) for members of the group.
-
valueBoolean¶ The value of the trait that holds (or does not hold - see ‘exclude’) for members of the group.
-
valueQuantity¶ The value of the trait that holds (or does not hold - see ‘exclude’) for members of the group.
-
valueRange¶ The value of the trait that holds (or does not hold - see ‘exclude’) for members of the group.
-
exclude¶ If true, indicates the characteristic is one that is NOT held by members of the group.
-
period¶ The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.
-
-
class
cardea.fhir.Group_Member(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized; i.e. a collection of entities that isn’t an Organization.
-
entity¶ A reference to the entity that is a member of the group. Must be consistent with Group.type.
-
period¶ The period that the member was in the group, if known.
-
inactive¶ A flag to indicate that the member is no longer in the group, but previously may have been a member.
-
-
class
cardea.fhir.GuidanceResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA guidance response is the formal response to a guidance request, including any output parameters returned by the evaluation, as well as the description of any proposed actions to be taken.
-
resourceType¶ This is a GuidanceResponse resource
-
requestId¶ The id of the request associated with this response. If an id was given as part of the request, it will be reproduced here to enable the requester to more easily identify the response in a multi-request scenario.
-
identifier¶ Allows a service to provide a unique, business identifier for the response.
-
module¶ A reference to the knowledge module that was invoked.
-
status¶ The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information.
-
subject¶ The patient for which the request was processed.
-
context¶ Allows the context of the guidance response to be provided if available. In a service context, this would likely be unavailable.
-
occurrenceDateTime¶ Indicates when the guidance response was processed.
-
performer¶ Provides a reference to the device that performed the guidance.
-
reasonCodeableConcept¶ Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
-
reasonReference¶ Indicates the reason the request was initiated. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
-
note¶ Provides a mechanism to communicate additional information about the response.
-
evaluationMessage¶ Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element.
-
outputParameters¶ The output parameters of the evaluation, if any. Many modules will result in the return of specific resources such as procedure or communication requests that are returned as part of the operation result. However, modules may define specific outputs that would be returned as the result of the evaluation, and these would be returned in this element.
-
result¶ The actions, if any, produced by the evaluation of the artifact.
-
dataRequirement¶ If the evaluation could not be completed due to lack of information, or additional information would potentially result in a more accurate response, this element will a description of the data required in order to proceed with the evaluation. A subsequent request to the service should include this data.
-
-
class
cardea.fhir.HealthcareService(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe details of a healthcare service available at a location.
-
resourceType¶ This is a HealthcareService resource
-
identifier¶ External identifiers for this item.
-
active¶ Whether this healthcareservice record is in active use.
-
providedBy¶ The organization that provides this healthcare service.
-
category¶ Identifies the broad category of service being performed or delivered.
-
type¶ The specific type of service that may be delivered or performed.
-
specialty¶ Collection of specialties handled by the service site. This is more of a medical term.
-
location¶ The location(s) where this healthcare service may be provided.
-
name¶ Further description of the service as it would be presented to a consumer while searching.
-
comment¶ Any additional description of the service and/or any specific issues not covered by the other attributes, which can be displayed as further detail under the serviceName.
-
extraDetails¶ Extra details about the service that can’t be placed in the other fields.
-
photo¶ If there is a photo/symbol associated with this HealthcareService, it may be included here to facilitate quick identification of the service in a list.
-
telecom¶ List of contacts related to this specific healthcare service.
-
coverageArea¶ The location(s) that this service is available to (not where the service is provided).
-
serviceProvisionCode¶ The code(s) that detail the conditions under which the healthcare service is available/offered.
-
eligibility¶ Does this service have specific eligibility requirements that need to be met in order to use the service?
-
eligibilityNote¶ Describes the eligibility conditions for the service.
-
programName¶ Program Names that can be used to categorize the service.
-
characteristic¶ Collection of characteristics (attributes).
-
referralMethod¶ Ways that the service accepts referrals, if this is not provided then it is implied that no referral is required.
-
appointmentRequired¶ Indicates whether or not a prospective consumer will require an appointment for a particular service at a site to be provided by the Organization. Indicates if an appointment is required for access to this service.
-
availableTime¶ A collection of times that the Service Site is available.
-
notAvailable¶ The HealthcareService is not available during this period of time due to the provided reason.
-
availabilityExceptions¶ A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
-
endpoint¶ Technical endpoints providing access to services operated for the specific healthcare services defined at this resource.
-
-
class
cardea.fhir.HealthcareService_AvailableTime(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe details of a healthcare service available at a location.
-
daysOfWeek¶ Indicates which days of the week are available between the start and end Times.
-
allDay¶ Is this always available? (hence times are irrelevant) e.g. 24 hour service.
-
availableStartTime¶ The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
-
availableEndTime¶ The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
-
-
class
cardea.fhir.HealthcareService_NotAvailable(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe details of a healthcare service available at a location.
-
description¶ The reason that can be presented to the user as to why this time is not available.
-
during¶ Service is not available (seasonally or for a public holiday) from this date.
-
-
class
cardea.fhir.HumanName(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA human’s name with the ability to identify parts and usage.
-
use¶ Identifies the purpose for this name.
-
text¶ A full text representation of the name.
-
family¶ The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
-
given¶ Given name.
-
prefix¶ Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
-
suffix¶ Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
-
period¶ Indicates the period of time when this name was valid for the named person.
-
-
class
cardea.fhir.Identifier(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA technical identifier - identifies some entity uniquely and unambiguously.
-
use¶ The purpose of this identifier.
-
type¶ A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
-
system¶ Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
-
value¶ The portion of the identifier typically relevant to the user and which is unique within the context of the system.
-
period¶ Time period during which identifier is/was valid for use.
-
assigner¶ Organization that issued/manages the identifier.
-
-
class
cardea.fhir.ImagingManifest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.
-
resourceType¶ This is a ImagingManifest resource
-
identifier¶ Unique identifier of the DICOM Key Object Selection (KOS) that this resource represents.
-
patient¶ A patient resource reference which is the patient subject of all DICOM SOP Instances in this ImagingManifest.
Date and time when the selection of the referenced instances were made. It is (typically) different from the creation date of the selection resource, and from dates associated with the referenced instances (e.g. capture time of the referenced image).
Author of ImagingManifest. It can be a human author or a device which made the decision of the SOP instances selected. For example, a radiologist selected a set of imaging SOP instances to attach in a diagnostic report, and a CAD application may author a selection to describe SOP instances it used to generate a detection conclusion.
-
description¶ Free text narrative description of the ImagingManifest. The value may be derived from the DICOM Standard Part 16, CID-7010 descriptions (e.g. Best in Set, Complete Study Content). Note that those values cover the wide range of uses of the DICOM Key Object Selection object, several of which are not supported by ImagingManifest. Specifically, there is no expected behavior associated with descriptions that suggest referenced images be removed or not used.
-
study¶ Study identity and locating information of the DICOM SOP instances in the selection.
-
-
class
cardea.fhir.ImagingManifest_Study(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.
-
uid¶ Study instance UID of the SOP instances in the selection.
-
imagingStudy¶ Reference to the Imaging Study in FHIR form.
-
endpoint¶ The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.type.
-
series¶ Series identity and locating information of the DICOM SOP instances in the selection.
-
-
class
cardea.fhir.ImagingManifest_Series(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.
-
uid¶ Series instance UID of the SOP instances in the selection.
-
endpoint¶ The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.type.
-
instance¶ Identity and locating information of the selected DICOM SOP instances.
-
-
class
cardea.fhir.ImagingManifest_Instance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA text description of the DICOM SOP instances selected in the ImagingManifest; or the reason for, or significance of, the selection.
-
sopClass¶ SOP class UID of the selected instance.
-
uid¶ SOP Instance UID of the selected instance.
-
-
class
cardea.fhir.ImagingStudy(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresentation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.
-
resourceType¶ This is a ImagingStudy resource
-
uid¶ Formal identifier for the study.
-
accession¶ Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).
-
identifier¶ Other identifiers for the study.
-
availability¶ Availability of study (online, offline, or nearline).
-
modalityList¶ A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).
-
patient¶ The patient imaged in the study.
-
context¶ The encounter or episode at which the request is initiated.
-
started¶ Date and time the study started.
-
basedOn¶ A list of the diagnostic requests that resulted in this imaging study being performed.
-
referrer¶ The requesting/referring physician.
-
interpreter¶ Who read the study and interpreted the images or other content.
-
endpoint¶ The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.type.
-
numberOfSeries¶ Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.
-
numberOfInstances¶ Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
-
procedureReference¶ A reference to the performed Procedure.
-
procedureCode¶ The code for the performed procedure type.
-
reason¶ Description of clinical condition indicating why the ImagingStudy was requested.
-
description¶ Institution-generated description or classification of the Study performed.
-
series¶ Each study has one or more series of images or other content.
-
-
class
cardea.fhir.ImagingStudy_Series(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresentation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.
-
uid¶ Formal identifier for this series.
-
number¶ The numeric identifier of this series in the study.
-
modality¶ The modality of this series sequence.
-
description¶ A description of the series.
-
numberOfInstances¶ Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
-
availability¶ Availability of series (online, offline or nearline).
-
endpoint¶ The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.type.
-
bodySite¶ The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.
-
laterality¶ The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.
-
started¶ The date and time the series was started.
-
performer¶ The physician or operator (often the radiology technician) who performed the series. The performer is recorded at the series level, since each series in a study may be performed by a different practitioner, at different times, and using different devices. A series may be performed by multiple practitioners.
-
instance¶ A single SOP instance within the series, e.g. an image, or presentation state.
-
-
class
cardea.fhir.ImagingStudy_Instance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRepresentation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.
-
uid¶ Formal identifier for this image or other content.
-
number¶ The number of instance in the series.
-
sopClass¶ DICOM instance type.
-
title¶ The description of the instance.
-
-
class
cardea.fhir.Immunization(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
-
resourceType¶ This is a Immunization resource
-
identifier¶ A unique identifier assigned to this immunization record.
-
status¶ Indicates the current status of the vaccination event.
-
notGiven¶ Indicates if the vaccination was or was not given.
-
vaccineCode¶ Vaccine that was administered or was to be administered.
-
patient¶ The patient who either received or did not receive the immunization.
-
encounter¶ The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
-
date¶ Date vaccine administered or was to be administered.
-
primarySource¶ An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
-
reportOrigin¶ The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
-
location¶ The service delivery location where the vaccine administration occurred.
-
manufacturer¶ Name of vaccine manufacturer.
-
lotNumber¶ Lot number of the vaccine product.
-
expirationDate¶ Date vaccine batch expires.
-
site¶ Body site where vaccine was administered.
-
route¶ The path by which the vaccine product is taken into the body.
-
doseQuantity¶ The quantity of vaccine product that was administered.
-
practitioner¶ Indicates who or what performed the event.
-
note¶ Extra information about the immunization that is not conveyed by the other attributes.
-
explanation¶ Reasons why a vaccine was or was not administered.
-
reaction¶ Categorical data indicating that an adverse event is associated in time to an immunization.
-
vaccinationProtocol¶ Contains information about the protocol(s) under which the vaccine was administered.
-
-
class
cardea.fhir.Immunization_Practitioner(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
-
role¶ Describes the type of performance (e.g. ordering provider, administering provider, etc.).
-
actor¶ The device, practitioner, etc. who performed the action.
-
-
class
cardea.fhir.Immunization_Explanation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
-
reason¶ Reasons why a vaccine was administered.
-
reasonNotGiven¶ Reason why a vaccine was not administered.
-
-
class
cardea.fhir.Immunization_Reaction(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
-
date¶ Date of reaction to the immunization.
-
detail¶ Details of the reaction.
-
reported¶ Self-reported indicator.
-
-
class
cardea.fhir.Immunization_VaccinationProtocol(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
-
doseSequence¶ Nominal position in a series.
-
description¶ Contains the description about the protocol under which the vaccine was administered.
Indicates the authority who published the protocol. E.g. ACIP.
-
series¶ One possible path to achieve presumed immunity against a disease - within the context of an authority.
-
seriesDoses¶ The recommended number of doses to achieve immunity.
-
targetDisease¶ The targeted disease.
-
doseStatus¶ Indicates if the immunization event should “count” against the protocol.
-
doseStatusReason¶ Provides an explanation as to why an immunization event should or should not count against the protocol.
-
-
class
cardea.fhir.ImmunizationRecommendation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA patient’s point-in-time immunization and recommendation (i.e. forecasting a patient’s immunization eligibility according to a published schedule) with optional supporting justification.
-
resourceType¶ This is a ImmunizationRecommendation resource
-
identifier¶ A unique identifier assigned to this particular recommendation record.
-
patient¶ The patient the recommendations are for.
-
recommendation¶ Vaccine administration recommendations.
-
-
class
cardea.fhir.ImmunizationRecommendation_Recommendation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA patient’s point-in-time immunization and recommendation (i.e. forecasting a patient’s immunization eligibility according to a published schedule) with optional supporting justification.
-
date¶ The date the immunization recommendation was created.
-
vaccineCode¶ Vaccine that pertains to the recommendation.
-
targetDisease¶ The targeted disease for the recommendation.
-
doseNumber¶ The next recommended dose number (e.g. dose 2 is the next recommended dose).
-
forecastStatus¶ Vaccine administration status.
-
dateCriterion¶ Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.
-
protocol¶ Contains information about the protocol under which the vaccine was administered.
-
supportingImmunization¶ Immunization event history that supports the status and recommendation.
-
supportingPatientInformation¶ Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.
-
-
class
cardea.fhir.ImmunizationRecommendation_DateCriterion(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA patient’s point-in-time immunization and recommendation (i.e. forecasting a patient’s immunization eligibility according to a published schedule) with optional supporting justification.
-
code¶ Date classification of recommendation. For example, earliest date to give, latest date to give, etc.
-
value¶ The date whose meaning is specified by dateCriterion.code.
-
-
class
cardea.fhir.ImmunizationRecommendation_Protocol(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA patient’s point-in-time immunization and recommendation (i.e. forecasting a patient’s immunization eligibility according to a published schedule) with optional supporting justification.
-
doseSequence¶ Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.
-
description¶ Contains the description about the protocol under which the vaccine was administered.
Indicates the authority who published the protocol. For example, ACIP.
-
series¶ One possible path to achieve presumed immunity against a disease - within the context of an authority.
-
-
class
cardea.fhir.ImplementationGuide(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
-
resourceType¶ This is a ImplementationGuide resource
-
url¶ An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this implementation guide is (or will be) published. The URL SHOULD include the major version of the implementation guide. For more information see [Technical and Business Versions](resource.html#versions).
-
version¶ The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
status¶ The status of this implementation guide. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the implementation guide was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.
-
publisher¶ The name of the individual or organization that published the implementation guide.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the implementation guide from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate implementation guide instances.
-
jurisdiction¶ A legal or geographic region in which the implementation guide is intended to be used.
-
copyright¶ A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.
-
fhirVersion¶ The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.1 for this version.
-
dependency¶ Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
-
package¶ A logical group of resources. Logical groups can be used when building pages.
-
global¶ A set of profiles that all resources covered by this implementation guide must conform to.
-
binary¶ A binary file that is included in the implementation guide when it is published.
-
page¶ A page / section in the implementation guide. The root page is the implementation guide home page.
-
-
class
cardea.fhir.ImplementationGuide_Dependency(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
-
type¶ How the dependency is represented when the guide is published.
-
uri¶ Where the dependency is located.
-
-
class
cardea.fhir.ImplementationGuide_Package(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
-
name¶ The name for the group, as used in page.package.
-
description¶ Human readable text describing the package.
-
resource¶ A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource.
-
-
class
cardea.fhir.ImplementationGuide_Resource(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
-
example¶ Whether a resource is included in the guide as part of the rules defined by the guide, or just as an example of a resource that conforms to the rules and/or help implementers understand the intent of the guide.
-
name¶ A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).
-
description¶ A description of the reason that a resource has been included in the implementation guide.
-
acronym¶ A short code that may be used to identify the resource throughout the implementation guide.
-
sourceUri¶ Where this resource is found.
-
sourceReference¶ Where this resource is found.
-
exampleFor¶ Another resource that this resource is an example for. This is mostly used for resources that are included as examples of StructureDefinitions.
-
-
class
cardea.fhir.ImplementationGuide_Global(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
-
type¶ The type of resource that all instances must conform to.
-
profile¶ A reference to the profile that all instances must conform to.
-
-
class
cardea.fhir.ImplementationGuide_Page(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.
-
source¶ The source address for the page.
-
title¶ A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.
-
kind¶ The kind of page that this is. Some pages are autogenerated (list, example), and other kinds are of interest so that tools can navigate the user to the page of interest.
-
type¶ For constructed pages, what kind of resources to include in the list.
-
package¶ For constructed pages, a list of packages to include in the page (or else empty for everything).
-
format¶ The format of the page.
-
page¶ Nested Pages/Sections under this page.
-
-
class
cardea.fhir.Library(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.
-
resourceType¶ This is a Library resource
-
url¶ An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this library is (or will be) published. The URL SHOULD include the major version of the library. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.
-
version¶ The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
-
name¶ A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the library.
-
status¶ The status of this library. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
type¶ Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.
-
date¶ The date (and optionally time) when the library was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.
-
publisher¶ The name of the individual or organization that published the library.
-
description¶ A free text natural language description of the library from a consumer’s perspective.
-
purpose¶ Explaination of why this library is needed and why it has been designed as it has.
-
usage¶ A detailed description of how the library is used from a clinical perspective.
-
approvalDate¶ The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate¶ The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn’t change the original approval date.
-
effectivePeriod¶ The period during which the library content was or is planned to be in active use.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate library instances.
-
jurisdiction¶ A legal or geographic region in which the library is intended to be used.
-
topic¶ Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.
-
contributor¶ A contributor to the content of the library, including authors, editors, reviewers, and endorsers.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
copyright¶ A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.
Related artifacts such as additional documentation, justification, or bibliographic references.
-
parameter¶ The parameter element defines parameters used by the library.
-
dataRequirement¶ Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.
-
content¶ The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.
-
-
class
cardea.fhir.Linkage(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIdentifies two or more records (resource instances) that are referring to the same real-world “occurrence”.
-
resourceType¶ This is a Linkage resource
-
active¶ Indicates whether the asserted set of linkages are considered to be “in effect”.
Identifies the user or organization responsible for asserting the linkages and who establishes the context for evaluating the nature of each linkage.
-
item¶ Identifies one of the records that is considered to refer to the same real-world occurrence as well as how the items hould be evaluated within the collection of linked items.
-
-
class
cardea.fhir.Linkage_Item(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIdentifies two or more records (resource instances) that are referring to the same real-world “occurrence”.
-
type¶ Distinguishes which item is “source of truth” (if any) and which items are no longer considered to be current representations.
-
resource¶ The resource instance being linked as part of the group.
-
-
class
cardea.fhir.List(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of information summarized from a list of other resources.
-
resourceType¶ This is a List resource
-
identifier¶ Identifier for the List assigned for business purposes outside the context of FHIR.
-
status¶ Indicates the current state of this list.
-
mode¶ How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
-
title¶ A label for the list assigned by the author.
-
code¶ This code defines the purpose of the list - why it was created.
-
subject¶ The common subject (or patient) of the resources that are in the list, if there is one.
-
encounter¶ The encounter that is the context in which this list was created.
-
date¶ The date that the list was prepared.
-
source¶ The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.
-
orderedBy¶ What order applies to the items in the list.
-
note¶ Comments that apply to the overall list.
-
entry¶ Entries in this list.
-
emptyReason¶ If the list is empty, why the list is empty.
-
-
class
cardea.fhir.List_Entry(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of information summarized from a list of other resources.
-
flag¶ The flag allows the system constructing the list to indicate the role and significance of the item in the list.
-
deleted¶ True if this item is marked as deleted in the list.
-
date¶ When this item was added to the list.
-
item¶ A reference to the actual resource from which data was derived.
-
-
class
cardea.fhir.Location(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.
-
resourceType¶ This is a Location resource
-
identifier¶ Unique code or number identifying the location to its users.
-
status¶ The status property covers the general availability of the resource, not the current value which may be covered by the operationStatus, or by a schedule/slots if they are configured for the location.
-
operationalStatus¶ The Operational status covers operation values most relevant to beds (but can also apply to rooms/units/chair/etc such as an isolation unit/dialisys chair). This typically covers concepts such as contamination, housekeeping and other activities like maintenance.
-
name¶ Name of the location as used by humans. Does not need to be unique.
-
alias¶ A list of alternate names that the location is known as, or was known as in the past.
-
description¶ Description of the Location, which helps in finding or referencing the place.
-
mode¶ Indicates whether a resource instance represents a specific location or a class of locations.
-
type¶ Indicates the type of function performed at the location.
-
telecom¶ The contact details of communication devices available at the location. This can include phone numbers, fax numbers, mobile numbers, email addresses and web sites.
-
address¶ Physical location.
-
physicalType¶ Physical form of the location, e.g. building, room, vehicle, road.
-
position¶ The absolute geographic location of the Location, expressed using the WGS84 datum (This is the same co-ordinate system used in KML).
-
managingOrganization¶ The organization responsible for the provisioning and upkeep of the location.
-
partOf¶ Another Location which this Location is physically part of.
-
endpoint¶ Technical endpoints providing access to services operated for the location.
-
-
class
cardea.fhir.Location_Position(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDetails and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated.
-
longitude¶ Longitude. The value domain and the interpretation are the same as for the text of the longitude element in KML (see notes below).
-
latitude¶ Latitude. The value domain and the interpretation are the same as for the text of the latitude element in KML (see notes below).
-
altitude¶ Altitude. The value domain and the interpretation are the same as for the text of the altitude element in KML (see notes below).
-
-
class
cardea.fhir.Measure(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Measure resource provides the definition of a quality measure.
-
resourceType¶ This is a Measure resource
-
url¶ An absolute URI that is used to identify this measure when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this measure is (or will be) published. The URL SHOULD include the major version of the measure. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this measure when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the measure when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the measure author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
-
name¶ A natural language name identifying the measure. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the measure.
-
status¶ The status of this measure. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this measure is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the measure was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the measure changes.
-
publisher¶ The name of the individual or organization that published the measure.
-
description¶ A free text natural language description of the measure from a consumer’s perspective.
-
purpose¶ Explaination of why this measure is needed and why it has been designed as it has.
-
usage¶ A detailed description of how the measure is used from a clinical perspective.
-
approvalDate¶ The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate¶ The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn’t change the original approval date.
-
effectivePeriod¶ The period during which the measure content was or is planned to be in active use.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate measure instances.
-
jurisdiction¶ A legal or geographic region in which the measure is intended to be used.
-
topic¶ Descriptive topics related to the content of the measure. Topics provide a high-level categorization of the type of the measure that can be useful for filtering and searching.
-
contributor¶ A contributor to the content of the measure, including authors, editors, reviewers, and endorsers.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
copyright¶ A copyright statement relating to the measure and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the measure.
Related artifacts such as additional documentation, justification, or bibliographic references.
-
library¶ A reference to a Library resource containing the formal logic used by the measure.
-
disclaimer¶ Notices and disclaimers regarding the use of the measure, or related to intellectual property (such as code systems) referenced by the measure.
-
scoring¶ Indicates how the calculation is performed for the measure, including proportion, ratio, continuous variable, and cohort. The value set is extensible, allowing additional measure scoring types to be represented.
-
compositeScoring¶ If this is a composite measure, the scoring method used to combine the component measures to determine the composite score.
-
type¶ Indicates whether the measure is used to examine a process, an outcome over time, a patient-reported outcome, or a structure measure such as utilization.
-
riskAdjustment¶ A description of the risk adjustment factors that may impact the resulting score for the measure and how they may be accounted for when computing and reporting measure results.
-
rateAggregation¶ Describes how to combine the information calculated, based on logic in each of several populations, into one summarized result.
-
rationale¶ Provides a succint statement of the need for the measure. Usually includes statements pertaining to importance criterion: impact, gap in care, and evidence.
-
clinicalRecommendationStatement¶ Provides a summary of relevant clinical guidelines or other clinical recommendations supporting the measure.
-
improvementNotation¶ Information on whether an increase or decrease in score is the preferred result (e.g., a higher score indicates better quality OR a lower score indicates better quality OR quality is whthin a range).
-
definition¶ Provides a description of an individual term used within the measure.
-
guidance¶ Additional guidance for the measure including how it can be used in a clinical context, and the intent of the measure.
-
set¶ The measure set, e.g. Preventive Care and Screening.
-
group¶ A group of population criteria for the measure.
-
supplementalData¶ The supplemental data criteria for the measure report, specified as either the name of a valid CQL expression within a referenced library, or a valid FHIR Resource Path.
-
-
class
cardea.fhir.Measure_Group(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Measure resource provides the definition of a quality measure.
-
identifier¶ A unique identifier for the group. This identifier will used to report data for the group in the measure report.
-
name¶ Optional name or short description of this group.
-
description¶ The human readable description of this population group.
-
population¶ A population criteria for the measure.
-
stratifier¶ The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library, or a valid FHIR Resource Path.
-
-
class
cardea.fhir.Measure_Population(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Measure resource provides the definition of a quality measure.
-
identifier¶ A unique identifier for the population criteria. This identifier is used to report data against this criteria within the measure report.
-
code¶ The type of population criteria.
-
name¶ Optional name or short description of this population.
-
description¶ The human readable description of this population criteria.
-
criteria¶ The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria.
-
-
class
cardea.fhir.Measure_Stratifier(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Measure resource provides the definition of a quality measure.
-
identifier¶ The identifier for the stratifier used to coordinate the reported data back to this stratifier.
-
criteria¶ The criteria for the stratifier. This must be the name of an expression defined within a referenced library.
-
path¶ The path to an element that defines the stratifier, specified as a valid FHIR resource path.
-
-
class
cardea.fhir.Measure_SupplementalData(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe Measure resource provides the definition of a quality measure.
-
identifier¶ An identifier for the supplemental data.
-
usage¶ An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation.
-
criteria¶ The criteria for the supplemental data. This must be the name of a valid expression defined within a referenced library, and defines the data to be returned for this element.
-
path¶ The supplemental data to be supplied as part of the measure response, specified as a valid FHIR Resource Path.
-
-
class
cardea.fhir.MeasureReport(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe MeasureReport resource contains the results of evaluating a measure.
-
resourceType¶ This is a MeasureReport resource
-
identifier¶ A formal identifier that is used to identify this report when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
status¶ The report status. No data will be available until the report status is complete.
-
type¶ The type of measure report. This may be an individual report, which provides a single patient’s score for the measure; a patient listing, which returns the list of patients that meet the various criteria in the measure; or a summary report, which returns a population count for each of the criteria in the measure.
-
measure¶ A reference to the Measure that was evaluated to produce this report.
-
patient¶ Optional Patient if the report was requested for a single patient.
-
date¶ The date this measure report was generated.
-
reportingOrganization¶ Reporting Organization.
-
period¶ The reporting period for which the report was calculated.
-
group¶ The results of the calculation, one for each population group in the measure.
-
evaluatedResources¶ A reference to a Bundle containing the Resources that were used in the evaluation of this report.
-
-
class
cardea.fhir.MeasureReport_Group(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe MeasureReport resource contains the results of evaluating a measure.
-
identifier¶ The identifier of the population group as defined in the measure definition.
-
population¶ The populations that make up the population group, one for each type of population appropriate for the measure.
-
measureScore¶ The measure score for this population group, calculated as appropriate for the measure type and scoring method, and based on the contents of the populations defined in the group.
-
stratifier¶ When a measure includes multiple stratifiers, there will be a stratifier group for each stratifier defined by the measure.
-
-
class
cardea.fhir.MeasureReport_Population(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe MeasureReport resource contains the results of evaluating a measure.
-
identifier¶ The identifier of the population being reported, as defined by the population element of the measure.
-
code¶ The type of the population.
-
count¶ The number of members of the population.
-
patients¶ This element refers to a List of patient level MeasureReport resources, one for each patient in this population.
-
-
class
cardea.fhir.MeasureReport_Stratifier(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe MeasureReport resource contains the results of evaluating a measure.
-
identifier¶ The identifier of this stratifier, as defined in the measure definition.
-
stratum¶ This element contains the results for a single stratum within the stratifier. For example, when stratifying on administrative gender, there will be four strata, one for each possible gender value.
-
-
class
cardea.fhir.MeasureReport_Stratum(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe MeasureReport resource contains the results of evaluating a measure.
-
value¶ The value for this stratum, expressed as a string. When defining stratifiers on complex values, the value must be rendered such that the value for each stratum within the stratifier is unique.
-
population¶ The populations that make up the stratum, one for each type of population appropriate to the measure.
-
measureScore¶ The measure score for this stratum, calculated as appropriate for the measure type and scoring method, and based on only the members of this stratum.
-
-
class
cardea.fhir.MeasureReport_Population1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe MeasureReport resource contains the results of evaluating a measure.
-
identifier¶ The identifier of the population being reported, as defined by the population element of the measure.
-
code¶ The type of the population.
-
count¶ The number of members of the population in this stratum.
-
patients¶ This element refers to a List of patient level MeasureReport resources, one for each patient in this population in this stratum.
-
-
class
cardea.fhir.Media(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference.
-
resourceType¶ This is a Media resource
-
identifier¶ Identifiers associated with the image - these may include identifiers for the image itself, identifiers for the context of its collection (e.g. series ids) and context ids such as accession numbers or other workflow identifiers.
-
basedOn¶ A procedure that is fulfilled in whole or in part by the creation of this media.
-
type¶ Whether the media is a photo (still image), an audio recording, or a video recording.
-
subtype¶ Details of the type of the media - usually, how it was acquired (what type of device). If images sourced from a DICOM system, are wrapped in a Media resource, then this is the modality.
-
view¶ The name of the imaging view e.g. Lateral or Antero-posterior (AP).
-
subject¶ Who/What this Media is a record of.
-
context¶ The encounter or episode of care that establishes the context for this media.
-
occurrenceDateTime¶ The date and time(s) at which the media was collected.
-
occurrencePeriod¶ The date and time(s) at which the media was collected.
-
operator¶ The person who administered the collection of the image.
-
reasonCode¶ Describes why the event occurred in coded or textual form.
-
bodySite¶ Indicates the site on the subject’s body where the media was collected (i.e. the target site).
-
device¶ The device used to collect the media.
-
height¶ Height of the image in pixels (photo/video).
-
width¶ Width of the image in pixels (photo/video).
-
frames¶ The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.
-
duration¶ The duration of the recording in seconds - for audio and video.
-
content¶ The actual content of the media - inline or by direct reference to the media source file.
-
note¶ Comments made about the media by the performer, subject or other participants.
-
-
class
cardea.fhir.Medication(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.
-
resourceType¶ This is a Medication resource
-
code¶ A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
-
status¶ A code to indicate if the medication is in active use.
-
isBrand¶ Set to true if the item is attributable to a specific manufacturer.
-
isOverTheCounter¶ Set to true if the medication can be obtained without an order from a prescriber.
-
manufacturer¶ Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
-
form¶ Describes the form of the item. Powder; tablets; capsule.
-
ingredient¶ Identifies a particular constituent of interest in the product.
-
package¶ Information that only applies to packages (not products).
-
image¶ Photo(s) or graphic representation(s) of the medication.
-
-
class
cardea.fhir.Medication_Ingredient(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.
-
itemCodeableConcept¶ The actual ingredient - either a substance (simple ingredient) or another medication.
-
itemReference¶ The actual ingredient - either a substance (simple ingredient) or another medication.
-
isActive¶ Indication of whether this ingredient affects the therapeutic action of the drug.
-
amount¶ Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.
-
-
class
cardea.fhir.Medication_Package(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.
-
container¶ The kind of container that this package comes as.
-
content¶ A set of components that go to make up the described item.
-
batch¶ Information about a group of medication produced or packaged from one production run.
-
-
class
cardea.fhir.Medication_Content(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.
-
itemCodeableConcept¶ Identifies one of the items in the package.
-
itemReference¶ Identifies one of the items in the package.
-
amount¶ The amount of the product that is in the package.
-
-
class
cardea.fhir.Medication_Batch(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource is primarily used for the identification and definition of a medication. It covers the ingredients and the packaging for a medication.
-
lotNumber¶ The assigned lot number of a batch of the specified product.
-
expirationDate¶ When this specific batch of product will expire.
-
-
class
cardea.fhir.MedicationAdministration(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.
-
resourceType¶ This is a MedicationAdministration resource
-
identifier¶ External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.
-
definition¶ A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event.
-
partOf¶ A larger event of which this particular event is a component or step.
-
status¶ Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
-
category¶ Indicates the type of medication administration and where the medication is expected to be consumed or administered.
-
medicationCodeableConcept¶ Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
-
medicationReference¶ Identifies the medication that was administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
-
subject¶ The person or animal or group receiving the medication.
-
context¶ The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.
-
supportingInformation¶ Additional information (for example, patient height and weight) that supports the administration of the medication.
-
effectiveDateTime¶ A specific date/time or interval of time during which the administration took place (or did not take place, when the ‘notGiven’ attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
-
effectivePeriod¶ A specific date/time or interval of time during which the administration took place (or did not take place, when the ‘notGiven’ attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
-
performer¶ The individual who was responsible for giving the medication to the patient.
-
notGiven¶ Set this to true if the record is saying that the medication was NOT administered.
-
reasonNotGiven¶ A code indicating why the administration was not performed.
-
reasonCode¶ A code indicating why the medication was given.
-
reasonReference¶ Condition or observation that supports why the medication was administered.
-
prescription¶ The original request, instruction or authority to perform the administration.
-
device¶ The device used in administering the medication to the patient. For example, a particular infusion pump.
-
note¶ Extra information about the medication administration that is not conveyed by the other attributes.
-
dosage¶ Describes the medication dosage information details e.g. dose, rate, site, route, etc.
-
eventHistory¶ A summary of the events of interest that have occurred, such as when the administration was verified.
-
-
class
cardea.fhir.MedicationAdministration_Performer(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.
-
actor¶ The device, practitioner, etc. who performed the action.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
-
class
cardea.fhir.MedicationAdministration_Dosage(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDescribes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.
-
text¶ Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans. The dosage instructions should reflect the dosage of the medication that was administered.
-
site¶ A coded specification of the anatomic site where the medication first entered the body. For example, “left arm”.
-
route¶ A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.
-
method¶ A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.
-
dose¶ The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.
-
rateRatio¶ Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.
-
rateSimpleQuantity¶ Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.
-
-
class
cardea.fhir.MedicationDispense(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIndicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
-
resourceType¶ This is a MedicationDispense resource
-
identifier¶ Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.
-
partOf¶ The procedure that the dispense is done because of.
-
status¶ A code specifying the state of the set of dispense events.
-
category¶ Indicates type of medication dispense and where the medication is expected to be consumed or administered.
-
medicationCodeableConcept¶ Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
-
medicationReference¶ Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
-
subject¶ A link to a resource representing the person or the group to whom the medication will be given.
-
context¶ The encounter or episode of care that establishes the context for this event.
-
supportingInformation¶ Additional information that supports the medication being dispensed.
-
performer¶ Indicates who or what performed the event. It should be assumed that the performer is the dispenser of the medication.
Indicates the medication order that is being dispensed against.
-
type¶ Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
-
quantity¶ The amount of medication that has been dispensed. Includes unit of measure.
-
daysSupply¶ The amount of medication expressed as a timing amount.
-
whenPrepared¶ The time when the dispensed product was packaged and reviewed.
-
whenHandedOver¶ The time the dispensed product was provided to the patient or their representative.
-
destination¶ Identification of the facility/location where the medication was shipped to, as part of the dispense event.
-
receiver¶ Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.
-
note¶ Extra information about the dispense that could not be conveyed in the other attributes.
-
dosageInstruction¶ Indicates how the medication is to be used by the patient.
-
substitution¶ Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why. If nothing is specified, substitution was not done.
-
detectedIssue¶ Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.
-
notDone¶ True if the dispense was not performed for some reason.
-
notDoneReasonCodeableConcept¶ Indicates the reason why a dispense was not performed.
-
notDoneReasonReference¶ Indicates the reason why a dispense was not performed.
-
eventHistory¶ A summary of the events of interest that have occurred, such as when the dispense was verified.
-
-
class
cardea.fhir.MedicationDispense_Performer(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIndicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
-
actor¶ The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
-
class
cardea.fhir.MedicationDispense_Substitution(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseIndicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.
-
wasSubstituted¶ True if the dispenser dispensed a different drug or product from what was prescribed.
-
type¶ A code signifying whether a different drug was dispensed from what was prescribed.
-
reason¶ Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.
-
responsibleParty¶ The person or organization that has primary responsibility for the substitution.
-
-
class
cardea.fhir.MedicationRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called “MedicationRequest” rather than “MedicationPrescription” or “MedicationOrder” to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.
-
resourceType¶ This is a MedicationRequest resource
-
identifier¶ This records identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. For example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records must be tracked through an entire system.
-
definition¶ Protocol or definition followed by this request.
-
basedOn¶ A plan or request that is fulfilled in whole or in part by this medication request.
-
groupIdentifier¶ A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.
-
status¶ A code specifying the current state of the order. Generally this will be active or completed state.
-
intent¶ Whether the request is a proposal, plan, or an original order.
-
category¶ Indicates the type of medication order and where the medication is expected to be consumed or administered.
-
priority¶ Indicates how quickly the Medication Request should be addressed with respect to other requests.
-
medicationCodeableConcept¶ Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
-
medicationReference¶ Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.
-
subject¶ A link to a resource representing the person or set of individuals to whom the medication will be given.
-
context¶ A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.
-
supportingInformation¶ Include additional information (for example, patient height and weight) that supports the ordering of the medication.
The date (and perhaps time) when the prescription was initially written or authored on.
-
requester¶ The individual, organization or device that initiated the request and has responsibility for its activation.
-
recorder¶ The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
-
reasonCode¶ The reason or the indication for ordering the medication.
-
reasonReference¶ Condition or observation that supports why the medication was ordered.
-
note¶ Extra information about the prescription that could not be conveyed by the other attributes.
-
dosageInstruction¶ Indicates how the medication is to be used by the patient.
-
dispenseRequest¶ Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.
-
substitution¶ Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen. This block explains the prescriber’s intent. If nothing is specified substitution may be done.
-
priorPrescription¶ A link to a resource representing an earlier order related order or prescription.
-
detectedIssue¶ Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.
-
eventHistory¶ Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.
-
-
class
cardea.fhir.MedicationRequest_Requester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called “MedicationRequest” rather than “MedicationPrescription” or “MedicationOrder” to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.
-
agent¶ The healthcare professional responsible for authorizing the initial prescription.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
-
class
cardea.fhir.MedicationRequest_DispenseRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called “MedicationRequest” rather than “MedicationPrescription” or “MedicationOrder” to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.
-
validityPeriod¶ This indicates the validity period of a prescription (stale dating the Prescription).
-
numberOfRepeatsAllowed¶ An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus “3 repeats”, then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets.
-
quantity¶ The amount that is to be dispensed for one fill.
-
expectedSupplyDuration¶ Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.
-
performer¶ Indicates the intended dispensing Organization specified by the prescriber.
-
-
class
cardea.fhir.MedicationRequest_Substitution(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called “MedicationRequest” rather than “MedicationPrescription” or “MedicationOrder” to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.
-
allowed¶ True if the prescriber allows a different drug to be dispensed from what was prescribed.
-
reason¶ Indicates the reason for the substitution, or why substitution must or must not be performed.
-
-
class
cardea.fhir.MedicationStatement(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a medication that is being consumed by a patient. A MedicationStatement may indicate that the patient may be taking the medication now, or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient’s memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains The primary difference between a medication statement and a medication administration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medication statement is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the medication statement information may come from the patient’s memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.
-
resourceType¶ This is a MedicationStatement resource
-
identifier¶ External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.
-
basedOn¶ A plan, proposal or order that is fulfilled in whole or in part by this event.
-
partOf¶ A larger event of which this particular event is a component or step.
-
context¶ The encounter or episode of care that establishes the context for this MedicationStatement.
-
status¶ A code representing the patient or other source’s judgment about the state of the medication used that this statement is about. Generally this will be active or completed.
-
category¶ Indicates where type of medication statement and where the medication is expected to be consumed or administered.
-
medicationCodeableConcept¶ Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
-
medicationReference¶ Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
-
effectiveDateTime¶ The interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the wasNotGiven element is true).
-
effectivePeriod¶ The interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the wasNotGiven element is true).
-
dateAsserted¶ The date when the medication statement was asserted by the information source.
-
informationSource¶ The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationStatement is derived from other resources, e.g Claim or MedicationRequest.
-
subject¶ The person, animal or group who is/was taking the medication.
-
derivedFrom¶ Allows linking the MedicationStatement to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationStatement.
-
taken¶ Indicator of the certainty of whether the medication was taken by the patient.
-
reasonNotTaken¶ A code indicating why the medication was not taken.
-
reasonCode¶ A reason for why the medication is being/was taken.
-
reasonReference¶ Condition or observation that supports why the medication is being/was taken.
-
note¶ Provides extra information about the medication statement that is not conveyed by the other attributes.
-
dosage¶ Indicates how the medication is/was or should be taken by the patient.
-
-
class
cardea.fhir.MessageDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDefines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
-
resourceType¶ This is a MessageDefinition resource
-
url¶ An absolute URI that is used to identify this message definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this message definition is (or will be) published. The URL SHOULD include the major version of the message definition. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the message definition.
-
status¶ The status of this message definition. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the message definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes.
-
publisher¶ The name of the individual or organization that published the message definition.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the message definition from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate message definition instances.
-
jurisdiction¶ A legal or geographic region in which the message definition is intended to be used.
-
purpose¶ Explaination of why this message definition is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.
-
base¶ The MessageDefinition that is the basis for the contents of this resource.
-
parent¶ Identifies a protocol or workflow that this MessageDefinition represents a step in.
-
replaces¶ A MessageDefinition that is superseded by this definition.
-
event¶ A coded identifier of a supported messaging event.
-
category¶ The impact of the content of the message.
-
focus¶ Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.
-
responseRequired¶ Indicates whether a response is required for this message.
-
allowedResponse¶ Indicates what types of messages may be sent as an application-level response to this message.
-
-
class
cardea.fhir.MessageDefinition_Focus(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDefines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
-
code¶ The kind of resource that must be the focus for this message.
-
profile¶ A profile that reflects constraints for the focal resource (and potentially for related resources).
-
min¶ Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.
-
max¶ Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.
-
-
class
cardea.fhir.MessageDefinition_AllowedResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDefines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
-
message¶ A reference to the message definition that must be adhered to by this supported response.
-
situation¶ Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).
-
-
class
cardea.fhir.MessageHeader(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
-
resourceType¶ This is a MessageHeader resource
-
event¶ Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value “http://hl7.org/fhir/message-events”.
-
destination¶ The destination application which the message is intended for.
-
receiver¶ Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn’t sufficient.
-
sender¶ Identifies the sending system to allow the use of a trust relationship.
-
timestamp¶ The time that the message was sent.
-
enterer¶ The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.
The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.
-
source¶ The source application from which this message originated.
-
responsible¶ The person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.
-
reason¶ Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
-
response¶ Information about the message that this message is a response to. Only present if this message is a response.
-
focus¶ The actual data of the message - a reference to the root/focus class of the event.
-
-
class
cardea.fhir.MessageHeader_Destination(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
-
name¶ Human-readable name for the target system.
-
target¶ Identifies the target end system in situations where the initial message transmission is to an intermediary system.
-
endpoint¶ Indicates where the message should be routed to.
-
-
class
cardea.fhir.MessageHeader_Source(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
-
name¶ Human-readable name for the source system.
-
software¶ May include configuration or other information useful in debugging.
-
version¶ Can convey versions of multiple systems in situations where a message passes through multiple hands.
-
contact¶ An e-mail, phone, website or other contact point to use to resolve issues with message communications.
-
endpoint¶ Identifies the routing target to send acknowledgements to.
-
-
class
cardea.fhir.MessageHeader_Response(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
-
identifier¶ The MessageHeader.id of the message to which this message is a response.
-
code¶ Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not.
-
details¶ Full details of any issues found in the message.
-
-
class
cardea.fhir.Meta(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
-
versionId¶ The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.
-
lastUpdated¶ When the resource last changed - e.g. when the version changed.
-
profile¶ A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
-
security¶ Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
-
tag¶ Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
-
-
class
cardea.fhir.Money(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn amount of economic utility in some recognized currency.
-
class
cardea.fhir.NamingSystem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a “System” used within the Identifier and Coding data types.
-
resourceType¶ This is a NamingSystem resource
-
name¶ A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
status¶ The status of this naming system. Enables tracking the life-cycle of the content.
-
kind¶ Indicates the purpose for the naming system - what kinds of things does it make unique?
-
date¶ The date (and optionally time) when the naming system was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.
-
publisher¶ The name of the individual or organization that published the naming system.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
responsible¶ The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
-
type¶ Categorizes a naming system for easier search by grouping related naming systems.
-
description¶ A free text natural language description of the naming system from a consumer’s perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate naming system instances.
-
jurisdiction¶ A legal or geographic region in which the naming system is intended to be used.
-
usage¶ Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
-
uniqueId¶ Indicates how the system may be identified when referenced in electronic exchange.
-
replacedBy¶ For naming systems that are retired, indicates the naming system that should be used in their place (if any).
-
-
class
cardea.fhir.NamingSystem_UniqueId(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a “System” used within the Identifier and Coding data types.
-
type¶ Identifies the unique identifier scheme used for this particular identifier.
-
value¶ The string that should be sent over the wire to identify the code system or identifier system.
-
preferred¶ Indicates whether this identifier is the “preferred” identifier of this type.
-
comment¶ Notes about the past or intended usage of this identifier.
-
period¶ Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.
-
-
class
cardea.fhir.Narrative(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA human-readable formatted text, including images.
-
status¶ The status of the narrative - whether it’s entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
-
div¶ The actual narrative content, a stripped down version of XHTML.
-
-
class
cardea.fhir.NutritionOrder(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
-
resourceType¶ This is a NutritionOrder resource
-
identifier¶ Identifiers assigned to this order by the order sender or by the order receiver.
-
status¶ The workflow status of the nutrition order/request.
-
patient¶ The person (patient) who needs the nutrition order for an oral diet, nutritional supplement and/or enteral or formula feeding.
-
encounter¶ An encounter that provides additional information about the healthcare context in which this request is made.
-
dateTime¶ The date and time that this nutrition order was requested.
-
orderer¶ The practitioner that holds legal responsibility for ordering the diet, nutritional supplement, or formula feedings.
-
allergyIntolerance¶ A link to a record of allergies or intolerances which should be included in the nutrition order.
-
foodPreferenceModifier¶ This modifier is used to convey order-specific modifiers about the type of food that should be given. These can be derived from patient allergies, intolerances, or preferences such as Halal, Vegan or Kosher. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.
-
excludeFoodModifier¶ This modifier is used to convey order-specific modifiers about the type of food that should NOT be given. These can be derived from patient allergies, intolerances, or preferences such as No Red Meat, No Soy or No Wheat or Gluten-Free. While it should not be necessary to repeat allergy or intolerance information captured in the referenced AllergyIntolerance resource in the excludeFoodModifier, this element may be used to convey additional specificity related to foods that should be eliminated from the patient’s diet for any reason. This modifier applies to the entire nutrition order inclusive of the oral diet, nutritional supplements and enteral formula feedings.
-
oralDiet¶ Diet given orally in contrast to enteral (tube) feeding.
-
supplement¶ Oral nutritional products given in order to add further nutritional value to the patient’s diet.
-
enteralFormula¶ Feeding provided through the gastrointestinal tract via a tube, catheter, or stoma that delivers nutrition distal to the oral cavity.
-
-
class
cardea.fhir.NutritionOrder_OralDiet(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
-
type¶ The kind of diet or dietary restriction such as fiber restricted diet or diabetic diet.
-
schedule¶ The time period and frequency at which the diet should be given. The diet should be given for the combination of all schedules if more than one schedule is present.
-
nutrient¶ Class that defines the quantity and type of nutrient modifications (for example carbohydrate, fiber or sodium) required for the oral diet.
-
texture¶ Class that describes any texture modifications required for the patient to safely consume various types of solid foods.
-
fluidConsistencyType¶ The required consistency (e.g. honey-thick, nectar-thick, thin, thickened.) of liquids or fluids served to the patient.
-
instruction¶ Free text or additional instructions or information pertaining to the oral diet.
-
-
class
cardea.fhir.NutritionOrder_Nutrient(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
-
modifier¶ The nutrient that is being modified such as carbohydrate or sodium.
-
amount¶ The quantity of the specified nutrient to include in diet.
-
-
class
cardea.fhir.NutritionOrder_Texture(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
-
modifier¶ Any texture modifications (for solid foods) that should be made, e.g. easy to chew, chopped, ground, and pureed.
-
foodType¶ The food type(s) (e.g. meats, all foods) that the texture modification applies to. This could be all foods types.
-
-
class
cardea.fhir.NutritionOrder_Supplement(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
-
type¶ The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement.
-
productName¶ The product or brand name of the nutritional supplement such as “Acme Protein Shake”.
-
schedule¶ The time period and frequency at which the supplement(s) should be given. The supplement should be given for the combination of all schedules if more than one schedule is present.
-
quantity¶ The amount of the nutritional supplement to be given.
-
instruction¶ Free text or additional instructions or information pertaining to the oral supplement.
-
-
class
cardea.fhir.NutritionOrder_EnteralFormula(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
-
baseFormulaType¶ The type of enteral or infant formula such as an adult standard formula with fiber or a soy-based infant formula.
-
baseFormulaProductName¶ The product or brand name of the enteral or infant formula product such as “ACME Adult Standard Formula”.
-
additiveType¶ Indicates the type of modular component such as protein, carbohydrate, fat or fiber to be provided in addition to or mixed with the base formula.
-
additiveProductName¶ The product or brand name of the type of modular component to be added to the formula.
-
caloricDensity¶ The amount of energy (calories) that the formula should provide per specified volume, typically per mL or fluid oz. For example, an infant may require a formula that provides 24 calories per fluid ounce or an adult may require an enteral formula that provides 1.5 calorie/mL.
-
routeofAdministration¶ The route or physiological path of administration into the patient’s gastrointestinal tract for purposes of providing the formula feeding, e.g. nasogastric tube.
-
administration¶ Formula administration instructions as structured data. This repeating structure allows for changing the administration rate or volume over time for both bolus and continuous feeding. An example of this would be an instruction to increase the rate of continuous feeding every 2 hours.
-
maxVolumeToDeliver¶ The maximum total quantity of formula that may be administered to a subject over the period of time, e.g. 1440 mL over 24 hours.
-
administrationInstruction¶ Free text formula administration, feeding instructions or additional instructions or information.
-
-
class
cardea.fhir.NutritionOrder_Administration(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident.
-
schedule¶ The time period and frequency at which the enteral formula should be delivered to the patient.
-
quantity¶ The volume of formula to provide to the patient per the specified administration schedule.
-
rateSimpleQuantity¶ The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.
-
rateRatio¶ The rate of administration of formula via a feeding pump, e.g. 60 mL per hour, according to the specified schedule.
-
-
class
cardea.fhir.Observation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseMeasurements and simple assertions made about a patient, device or other subject.
-
resourceType¶ This is a Observation resource
-
identifier¶ A unique identifier assigned to this observation.
-
basedOn¶ A plan, proposal or order that is fulfilled in whole or in part by this event.
-
status¶ The status of the result value.
-
category¶ A code that classifies the general type of observation being made.
-
code¶ Describes what was observed. Sometimes this is called the observation “name”.
-
subject¶ The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.
-
context¶ The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.
-
effectiveDateTime¶ The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the “physiologically relevant time”. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
-
effectivePeriod¶ The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the “physiologically relevant time”. This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.
-
issued¶ The date and time this observation was made available to providers, typically after the results have been reviewed and verified.
-
performer¶ Who was responsible for asserting the observed value as “true”.
-
valueQuantity¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueCodeableConcept¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueString¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueBoolean¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueRange¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueRatio¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueSampledData¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueAttachment¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueTime¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueDateTime¶ The information determined as a result of making the observation, if the information has a simple value.
-
valuePeriod¶ The information determined as a result of making the observation, if the information has a simple value.
-
dataAbsentReason¶ Provides a reason why the expected value in the element Observation.value[x] is missing.
-
interpretation¶ The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
-
comment¶ May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.
-
bodySite¶ Indicates the site on the subject’s body where the observation was made (i.e. the target site).
-
method¶ Indicates the mechanism used to perform the observation.
-
specimen¶ The specimen that was used when this observation was made.
-
device¶ The device used to generate the observation data.
-
referenceRange¶ Guidance on how to interpret the value by comparison to a normal or recommended range.
A reference to another resource (usually another Observation) whose relationship is defined by the relationship type code.
-
component¶ Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.
-
-
class
cardea.fhir.Observation_ReferenceRange(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseMeasurements and simple assertions made about a patient, device or other subject.
-
low¶ The value of the low bound of the reference range. The low bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the low bound is omitted, it is assumed to be meaningless (e.g. reference range is <=2.3).
-
high¶ The value of the high bound of the reference range. The high bound of the reference range endpoint is inclusive of the value (e.g. reference range is >=5 - <=9). If the high bound is omitted, it is assumed to be meaningless (e.g. reference range is >= 2.3).
-
type¶ Codes to indicate the what part of the targeted reference population it applies to. For example, the normal or therapeutic range.
-
appliesTo¶ Codes to indicate the target population this reference range applies to. For example, a reference range may be based on the normal population or a particular sex or race.
-
age¶ The age at which this reference range is applicable. This is a neonatal age (e.g. number of weeks at term) if the meaning says so.
-
text¶ Text based reference range in an observation which may be used when a quantitative range is not appropriate for an observation. An example would be a reference value of “Negative” or a list or table of ‘normals’.
-
-
class
cardea.fhir.Observation_Related(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseMeasurements and simple assertions made about a patient, device or other subject.
-
type¶ A code specifying the kind of relationship that exists with the target resource.
-
target¶ A reference to the observation or [[[QuestionnaireResponse]]] resource that is related to this observation.
-
-
class
cardea.fhir.Observation_Component(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseMeasurements and simple assertions made about a patient, device or other subject.
-
code¶ Describes what was observed. Sometimes this is called the observation “code”.
-
valueQuantity¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueCodeableConcept¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueString¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueRange¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueRatio¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueSampledData¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueAttachment¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueTime¶ The information determined as a result of making the observation, if the information has a simple value.
-
valueDateTime¶ The information determined as a result of making the observation, if the information has a simple value.
-
valuePeriod¶ The information determined as a result of making the observation, if the information has a simple value.
-
dataAbsentReason¶ Provides a reason why the expected value in the element Observation.value[x] is missing.
-
interpretation¶ The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.
-
referenceRange¶ Guidance on how to interpret the value by comparison to a normal or recommended range.
-
-
class
cardea.fhir.OperationDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
-
resourceType¶ This is a OperationDefinition resource
-
url¶ An absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published. The URL SHOULD include the major version of the operation definition. For more information see [Technical and Business Versions](resource.html#versions).
-
version¶ The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
status¶ The status of this operation definition. Enables tracking the life-cycle of the content.
-
kind¶ Whether this is an operation or a named query.
-
experimental¶ A boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the operation definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes.
-
publisher¶ The name of the individual or organization that published the operation definition.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the operation definition from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate operation definition instances.
-
jurisdiction¶ A legal or geographic region in which the operation definition is intended to be used.
-
purpose¶ Explaination of why this operation definition is needed and why it has been designed as it has.
-
idempotent¶ Operations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.
-
code¶ The name used to invoke the operation.
-
comment¶ Additional information about how to use this operation or named query.
-
base¶ Indicates that this operation definition is a constraining profile on the base.
-
resource¶ The types on which this operation can be executed.
-
system¶ Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).
-
type¶ Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).
-
instance¶ Indicates whether this operation can be invoked on a particular instance of one of the given types.
-
parameter¶ The parameters for the operation/query.
-
overload¶ Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.
-
-
class
cardea.fhir.OperationDefinition_Parameter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
-
name¶ The name of used to identify the parameter.
-
use¶ Whether this is an input or an output parameter.
-
min¶ The minimum number of times this parameter SHALL appear in the request or response.
-
max¶ The maximum number of times this element is permitted to appear in the request or response.
-
documentation¶ Describes the meaning or use of this parameter.
-
type¶ The type for this parameter.
-
searchType¶ How the parameter is understood as a search parameter. This is only used if the parameter type is ‘string’.
-
profile¶ A profile the specifies the rules that this parameter must conform to.
-
binding¶ Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).
-
part¶ The parts of a nested Parameter.
-
-
class
cardea.fhir.OperationDefinition_Binding(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
-
strength¶ Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.
-
valueSetUri¶ Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.
-
valueSetReference¶ Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.
-
-
class
cardea.fhir.OperationDefinition_Overload(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
-
parameterName¶ Name of parameter to include in overload.
-
comment¶ Comments to go on overload.
-
-
class
cardea.fhir.OperationOutcome(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA collection of error, warning or information messages that result from a system action.
-
resourceType¶ This is a OperationOutcome resource
-
issue¶ An error, warning or information message that results from a system action.
-
-
class
cardea.fhir.OperationOutcome_Issue(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA collection of error, warning or information messages that result from a system action.
-
severity¶ Indicates whether the issue indicates a variation from successful processing.
-
code¶ Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element.
-
details¶ Additional details about the error. This may be a text description of the error, or a system code that identifies the error.
-
diagnostics¶ Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stack dump to help trace the issue.
-
location¶ For resource issues, this will be a simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised. For HTTP errors, will be “http.” + the parameter name.
-
expression¶ A simple FHIRPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.
-
-
class
cardea.fhir.Organization(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.
-
resourceType¶ This is a Organization resource
-
identifier¶ Identifier for the organization that is used to identify the organization across multiple disparate systems.
-
active¶ Whether the organization’s record is still in active use.
-
type¶ The kind(s) of organization that this is.
-
name¶ A name associated with the organization.
-
alias¶ A list of alternate names that the organization is known as, or was known as in the past.
-
telecom¶ A contact detail for the organization.
-
address¶ An address for the organization.
-
partOf¶ The organization of which this organization forms a part.
-
contact¶ Contact for the organization for a certain purpose.
-
endpoint¶ Technical endpoints providing access to services operated for the organization.
-
-
class
cardea.fhir.Organization_Contact(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc.
-
purpose¶ Indicates a purpose for which the contact can be reached.
-
name¶ A name associated with the contact.
-
telecom¶ A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
-
address¶ Visiting or postal addresses for the contact.
-
-
class
cardea.fhir.ParameterDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.
-
name¶ The name of the parameter used to allow access to the value of the parameter in evaluation contexts.
-
use¶ Whether the parameter is input or output for the module.
-
min¶ The minimum number of times this parameter SHALL appear in the request or response.
-
max¶ The maximum number of times this element is permitted to appear in the request or response.
-
documentation¶ A brief discussion of what the parameter is for and how it is used by the module.
-
type¶ The type of the parameter.
-
profile¶ If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
-
-
class
cardea.fhir.Parameters(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis special resource type is used to represent an operation request and response (operations.html). It has no other use, and there is no RESTful endpoint associated with it.
-
parameter¶ A parameter passed to or received from the operation.
-
-
class
cardea.fhir.Parameters_Parameter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis special resource type is used to represent an operation request and response (operations.html). It has no other use, and there is no RESTful endpoint associated with it.
-
name¶ The name of the parameter (reference to the operation definition).
-
valueBoolean¶ If the parameter is a data type.
-
valueInteger¶ If the parameter is a data type.
-
valueDecimal¶ If the parameter is a data type.
-
valueBase64Binary¶ If the parameter is a data type.
-
valueInstant¶ If the parameter is a data type.
-
valueString¶ If the parameter is a data type.
-
valueUri¶ If the parameter is a data type.
-
valueDate¶ If the parameter is a data type.
-
valueDateTime¶ If the parameter is a data type.
-
valueTime¶ If the parameter is a data type.
-
valueCode¶ If the parameter is a data type.
-
valueOid¶ If the parameter is a data type.
-
valueUuid¶ If the parameter is a data type.
-
valueId¶ If the parameter is a data type.
-
valueUnsignedInt¶ If the parameter is a data type.
-
valuePositiveInt¶ If the parameter is a data type.
-
valueMarkdown¶ If the parameter is a data type.
-
valueElement¶ If the parameter is a data type.
-
valueExtension¶ If the parameter is a data type.
-
valueBackboneElement¶ If the parameter is a data type.
-
valueNarrative¶ If the parameter is a data type.
-
valueAnnotation¶ If the parameter is a data type.
-
valueAttachment¶ If the parameter is a data type.
-
valueIdentifier¶ If the parameter is a data type.
-
valueCodeableConcept¶ If the parameter is a data type.
-
valueCoding¶ If the parameter is a data type.
-
valueQuantity¶ If the parameter is a data type.
-
valueDuration¶ If the parameter is a data type.
-
valueSimpleQuantity¶ If the parameter is a data type.
-
valueDistance¶ If the parameter is a data type.
-
valueCount¶ If the parameter is a data type.
-
valueMoney¶ If the parameter is a data type.
-
valueAge¶ If the parameter is a data type.
-
valueRange¶ If the parameter is a data type.
-
valuePeriod¶ If the parameter is a data type.
-
valueRatio¶ If the parameter is a data type.
-
valueReference¶ If the parameter is a data type.
-
valueSampledData¶ If the parameter is a data type.
-
valueSignature¶ If the parameter is a data type.
-
valueHumanName¶ If the parameter is a data type.
-
valueAddress¶ If the parameter is a data type.
-
valueContactPoint¶ If the parameter is a data type.
-
valueTiming¶ If the parameter is a data type.
-
valueMeta¶ If the parameter is a data type.
-
valueElementDefinition¶ If the parameter is a data type.
-
valueContactDetail¶ If the parameter is a data type.
-
valueContributor¶ If the parameter is a data type.
-
valueDosage¶ If the parameter is a data type.
-
valueRelatedArtifact¶ If the parameter is a data type.
-
valueUsageContext¶ If the parameter is a data type.
-
valueDataRequirement¶ If the parameter is a data type.
-
valueParameterDefinition¶ If the parameter is a data type.
-
valueTriggerDefinition¶ If the parameter is a data type.
-
resource¶ If the parameter is a whole resource.
-
part¶ A named part of a multi-part parameter.
-
-
class
cardea.fhir.Patient(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDemographics and other administrative information about an individual or animal receiving care or other health-related services.
-
resourceType¶ This is a Patient resource
-
identifier¶ An identifier for this patient.
-
active¶ Whether this patient record is in active use.
-
name¶ A name associated with the individual.
-
telecom¶ A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
-
gender¶ Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
-
birthDate¶ The date of birth for the individual.
-
deceasedBoolean¶ Indicates if the individual is deceased or not.
-
deceasedDateTime¶ Indicates if the individual is deceased or not.
-
address¶ Addresses for the individual.
-
maritalStatus¶ This field contains a patient’s most recent marital (civil) status.
-
multipleBirthBoolean¶ Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
-
multipleBirthInteger¶ Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
-
photo¶ Image of the patient.
-
contact¶ A contact party (e.g. guardian, partner, friend) for the patient.
-
animal¶ This patient is known to be an animal.
-
communication¶ Languages which may be used to communicate with the patient about his or her health.
-
generalPractitioner¶ Patient’s nominated care provider.
-
managingOrganization¶ Organization that is the custodian of the patient record.
-
link¶ Link to another patient resource that concerns the same actual patient.
-
-
class
cardea.fhir.Patient_Contact(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDemographics and other administrative information about an individual or animal receiving care or other health-related services.
-
relationship¶ The nature of the relationship between the patient and the contact person.
-
name¶ A name associated with the contact person.
-
telecom¶ A contact detail for the person, e.g. a telephone number or an email address.
-
address¶ Address for the contact person.
-
gender¶ Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
-
organization¶ Organization on behalf of which the contact is acting or for which the contact is working.
-
period¶ The period during which this contact person or organization is valid to be contacted relating to this patient.
-
-
class
cardea.fhir.Patient_Animal(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDemographics and other administrative information about an individual or animal receiving care or other health-related services.
-
species¶ Identifies the high level taxonomic categorization of the kind of animal.
-
breed¶ Identifies the detailed categorization of the kind of animal.
-
genderStatus¶ Indicates the current state of the animal’s reproductive organs.
-
-
class
cardea.fhir.Patient_Communication(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDemographics and other administrative information about an individual or animal receiving care or other health-related services.
-
language¶ The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. “en” for English, or “en-US” for American English versus “en-EN” for England English.
-
preferred¶ Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).
-
-
class
cardea.fhir.Patient_Link(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDemographics and other administrative information about an individual or animal receiving care or other health-related services.
-
other¶ The other patient resource that the link refers to.
-
type¶ The type of link between this patient resource and another patient resource.
-
-
class
cardea.fhir.PaymentNotice(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the status of the payment for goods and services rendered, and the request and response resource references.
-
resourceType¶ This is a PaymentNotice resource
-
identifier¶ The notice business identifier.
-
status¶ The status of the resource instance.
-
request¶ Reference of resource for which payment is being made.
-
response¶ Reference of response to resource for which payment is being made.
-
statusDate¶ The date when the above payment action occurrred.
-
created¶ The date when this resource was created.
-
target¶ The Insurer who is target of the request.
-
provider¶ The practitioner who is responsible for the services rendered to the patient.
-
organization¶ The organization which is responsible for the services rendered to the patient.
-
paymentStatus¶ The payment status, typically paid: payment sent, cleared: payment received.
-
-
class
cardea.fhir.PaymentReconciliation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides payment details and claim references supporting a bulk payment.
-
resourceType¶ This is a PaymentReconciliation resource
-
identifier¶ The Response business identifier.
-
status¶ The status of the resource instance.
-
period¶ The period of time for which payments have been gathered into this bulk payment for settlement.
-
created¶ The date when the enclosed suite of services were performed or completed.
-
organization¶ The Insurer who produced this adjudicated response.
-
request¶ Original request resource reference.
-
outcome¶ Transaction status: error, complete.
-
disposition¶ A description of the status of the adjudication.
-
requestProvider¶ The practitioner who is responsible for the services rendered to the patient.
-
requestOrganization¶ The organization which is responsible for the services rendered to the patient.
-
detail¶ List of individual settlement amounts and the corresponding transaction.
-
form¶ The form to be used for printing the content.
-
total¶ Total payment amount.
-
processNote¶ Suite of notes.
-
-
class
cardea.fhir.PaymentReconciliation_Detail(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides payment details and claim references supporting a bulk payment.
-
type¶ Code to indicate the nature of the payment, adjustment, funds advance, etc.
-
request¶ The claim or financial resource.
-
response¶ The claim response resource.
-
submitter¶ The Organization which submitted the claim or financial transaction.
-
payee¶ The organization which is receiving the payment.
-
date¶ The date of the invoice or financial resource.
-
amount¶ Amount paid for this detail.
-
-
class
cardea.fhir.PaymentReconciliation_ProcessNote(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides payment details and claim references supporting a bulk payment.
-
type¶ The note purpose: Print/Display.
-
text¶ The note text.
-
-
class
cardea.fhir.Period(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA time period defined by a start and end date and optionally time.
-
start¶ The start of the period. The boundary is inclusive.
-
end¶ The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
-
-
class
cardea.fhir.Person(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDemographics and administrative information about a person independent of a specific health-related context.
-
resourceType¶ This is a Person resource
-
identifier¶ Identifier for a person within a particular scope.
-
name¶ A name associated with the person.
-
telecom¶ A contact detail for the person, e.g. a telephone number or an email address.
-
gender¶ Administrative Gender.
-
birthDate¶ The birth date for the person.
-
address¶ One or more addresses for the person.
-
photo¶ An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
-
managingOrganization¶ The organization that is the custodian of the person record.
-
active¶ Whether this person’s record is in active use.
-
link¶ Link to a resource that concerns the same actual person.
-
-
class
cardea.fhir.Person_Link(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseDemographics and administrative information about a person independent of a specific health-related context.
-
target¶ The resource to which this actual person is associated.
-
assurance¶ Level of assurance that this link is actually associated with the target resource.
-
-
class
cardea.fhir.PlanDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
resourceType¶ This is a PlanDefinition resource
-
url¶ An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
-
name¶ A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the plan definition.
-
type¶ The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.
-
status¶ The status of this plan definition. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the plan definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.
-
publisher¶ The name of the individual or organization that published the plan definition.
-
description¶ A free text natural language description of the plan definition from a consumer’s perspective.
-
purpose¶ Explaination of why this plan definition is needed and why it has been designed as it has.
-
usage¶ A detailed description of how the asset is used from a clinical perspective.
-
approvalDate¶ The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate¶ The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn’t change the original approval date.
-
effectivePeriod¶ The period during which the plan definition content was or is planned to be in active use.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate plan definition instances.
-
jurisdiction¶ A legal or geographic region in which the plan definition is intended to be used.
-
topic¶ Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.
-
contributor¶ A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
copyright¶ A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.
Related artifacts such as additional documentation, justification, or bibliographic references.
-
library¶ A reference to a Library resource containing any formal logic used by the plan definition.
-
goal¶ Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
-
action¶ An action to be taken as part of the plan.
-
-
class
cardea.fhir.PlanDefinition_Goal(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
category¶ Indicates a category the goal falls within.
-
description¶ Human-readable and/or coded description of a specific desired objective of care, such as “control blood pressure” or “negotiate an obstacle course” or “dance with child at wedding”.
-
priority¶ Identifies the expected level of importance associated with reaching/sustaining the defined goal.
-
start¶ The event after which the goal should begin being pursued.
-
addresses¶ Identifies problems, conditions, issues, or concerns the goal is intended to address.
-
documentation¶ Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.
-
target¶ Indicates what should be done and within what timeframe.
-
-
class
cardea.fhir.PlanDefinition_Target(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
measure¶ The parameter whose value is to be tracked, e.g. body weigth, blood pressure, or hemoglobin A1c level.
-
detailQuantity¶ The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. Whan a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.
-
detailRange¶ The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. Whan a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.
-
detailCodeableConcept¶ The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. Whan a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.
-
due¶ Indicates the timeframe after the start of the goal in which the goal should be met.
-
-
class
cardea.fhir.PlanDefinition_Action(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
label¶ A user-visible label for the action.
-
title¶ The title of the action displayed to a user.
-
description¶ A short description of the action used to provide a summary to display to the user.
-
textEquivalent¶ A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that may not be capable of interpreting it dynamically.
-
code¶ A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a the section of a documentation template.
-
reason¶ A description of why this action is necessary or appropriate.
-
documentation¶ Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.
-
goalId¶ Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
-
triggerDefinition¶ A description of when the action should be triggered.
-
condition¶ An expression that describes applicability criteria, or start/stop conditions for the action.
-
input¶ Defines input data requirements for the action.
-
output¶ Defines the outputs of the action, if any.
A relationship to another action such as “before” or “30-60 minutes after start of”.
-
timingDateTime¶ An optional value describing when the action should be performed.
-
timingPeriod¶ An optional value describing when the action should be performed.
-
timingDuration¶ An optional value describing when the action should be performed.
-
timingRange¶ An optional value describing when the action should be performed.
-
timingTiming¶ An optional value describing when the action should be performed.
-
participant¶ Indicates who should participate in performing the action described.
-
type¶ The type of action to perform (create, update, remove).
-
groupingBehavior¶ Defines the grouping behavior for the action and its children.
-
selectionBehavior¶ Defines the selection behavior for the action and its children.
-
requiredBehavior¶ Defines the requiredness behavior for the action.
-
precheckBehavior¶ Defines whether the action should usually be preselected.
-
cardinalityBehavior¶ Defines whether the action can be selected multiple times.
-
definition¶ A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
-
transform¶ A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
-
dynamicValue¶ Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient’s weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.
-
action¶ Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.
-
-
class
cardea.fhir.PlanDefinition_Condition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
kind¶ The kind of condition.
-
description¶ A brief, natural language description of the condition that effectively communicates the intended semantics.
-
language¶ The media type of the language for the expression.
-
expression¶ An expression that returns true or false, indicating whether or not the condition is satisfied.
-
-
class
cardea.fhir.PlanDefinition_RelatedAction(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
actionId¶ The element id of the related action.
-
relationship¶ The relationship of this action to the related action.
-
offsetDuration¶ A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
-
offsetRange¶ A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
-
-
class
cardea.fhir.PlanDefinition_Participant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
type¶ The type of participant in the action.
-
role¶ The role the participant should play in performing the described action.
-
-
class
cardea.fhir.PlanDefinition_DynamicValue(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
-
description¶ A brief, natural language description of the intended semantics of the dynamic value.
-
path¶ The path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression.
-
language¶ The media type of the language for the expression.
-
expression¶ An expression specifying the value of the customized element.
-
-
class
cardea.fhir.Practitioner(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA person who is directly or indirectly involved in the provisioning of healthcare.
-
resourceType¶ This is a Practitioner resource
-
identifier¶ An identifier that applies to this person in this role.
-
active¶ Whether this practitioner’s record is in active use.
-
name¶ The name(s) associated with the practitioner.
-
telecom¶ A contact detail for the practitioner, e.g. a telephone number or an email address.
-
address¶ Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.
-
gender¶ Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
-
birthDate¶ The date of birth for the practitioner.
-
photo¶ Image of the person.
-
qualification¶ Qualifications obtained by training and certification.
-
communication¶ A language the practitioner is able to use in patient communication.
-
-
class
cardea.fhir.Practitioner_Qualification(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA person who is directly or indirectly involved in the provisioning of healthcare.
-
identifier¶ An identifier that applies to this person’s qualification in this role.
-
code¶ Coded representation of the qualification.
-
period¶ Period during which the qualification is valid.
-
issuer¶ Organization that regulates and issues the qualification.
-
-
class
cardea.fhir.PractitionerRole(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
-
resourceType¶ This is a PractitionerRole resource
-
identifier¶ Business Identifiers that are specific to a role/location.
-
active¶ Whether this practitioner’s record is in active use.
-
period¶ The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
-
practitioner¶ Practitioner that is able to provide the defined services for the organation.
-
organization¶ The organization where the Practitioner performs the roles associated.
-
code¶ Roles which this practitioner is authorized to perform for the organization.
-
specialty¶ Specific specialty of the practitioner.
-
location¶ The location(s) at which this practitioner provides care.
-
healthcareService¶ The list of healthcare services that this worker provides for this role’s Organization/Location(s).
-
telecom¶ Contact details that are specific to the role/location/service.
-
availableTime¶ A collection of times that the Service Site is available.
-
notAvailable¶ The HealthcareService is not available during this period of time due to the provided reason.
-
availabilityExceptions¶ A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
-
endpoint¶ Technical endpoints providing access to services operated for the practitioner with this role.
-
-
class
cardea.fhir.PractitionerRole_AvailableTime(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
-
daysOfWeek¶ Indicates which days of the week are available between the start and end Times.
-
allDay¶ Is this always available? (hence times are irrelevant) e.g. 24 hour service.
-
availableStartTime¶ The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
-
availableEndTime¶ The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
-
-
class
cardea.fhir.PractitionerRole_NotAvailable(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
-
description¶ The reason that can be presented to the user as to why this time is not available.
-
during¶ Service is not available (seasonally or for a public holiday) from this date.
-
-
class
cardea.fhir.Procedure(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.
-
resourceType¶ This is a Procedure resource
-
identifier¶ This records identifiers associated with this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
-
definition¶ A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure.
-
basedOn¶ A reference to a resource that contains details of the request for this procedure.
-
partOf¶ A larger event of which this particular procedure is a component or step.
-
status¶ A code specifying the state of the procedure. Generally this will be in-progress or completed state.
-
notDone¶ Set this to true if the record is saying that the procedure was NOT performed.
-
notDoneReason¶ A code indicating why the procedure was not performed.
-
category¶ A code that classifies the procedure for searching, sorting and display purposes (e.g. “Surgical Procedure”).
-
code¶ The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. “Laparoscopic Appendectomy”).
-
subject¶ The person, animal or group on which the procedure was performed.
-
context¶ The encounter during which the procedure was performed.
-
performedDateTime¶ The date(time)/period over which the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
-
performedPeriod¶ The date(time)/period over which the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.
-
performer¶ Limited to ‘real’ people rather than equipment.
-
location¶ The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
-
reasonCode¶ The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text.
-
reasonReference¶ The condition that is the reason why the procedure was performed.
-
bodySite¶ Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
-
outcome¶ The outcome of the procedure - did it resolve reasons for the procedure being performed?
-
report¶ This could be a histology result, pathology report, surgical report, etc..
-
complication¶ Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any ‘post procedure’ issues.
-
complicationDetail¶ Any complications that occurred during the procedure, or in the immediate post-performance period.
-
followUp¶ If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or could potentially be more complex in which case the CarePlan resource can be used.
-
note¶ Any other notes about the procedure. E.g. the operative notes.
-
focalDevice¶ A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.
-
usedReference¶ Identifies medications, devices and any other substance used as part of the procedure.
-
usedCode¶ Identifies coded items that were used as part of the procedure.
-
-
class
cardea.fhir.Procedure_Performer(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.
-
role¶ For example: surgeon, anaethetist, endoscopist.
-
actor¶ The practitioner who was involved in the procedure.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
-
class
cardea.fhir.Procedure_FocalDevice(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.
-
action¶ The kind of change that happened to the device during the procedure.
-
manipulated¶ The device that was manipulated (changed) during the procedure.
-
-
class
cardea.fhir.ProcedureRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a request for diagnostic investigations, treatments, or operations to be performed.
-
resourceType¶ This is a ProcedureRequest resource
-
identifier¶ Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
-
definition¶ Protocol or definition followed by this request.
-
basedOn¶ Plan/proposal/order fulfilled by this request.
-
replaces¶ The request takes the place of the referenced completed or terminated request(s).
-
requisition¶ A shared identifier common to all procedure or diagnostic requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
-
status¶ The status of the order.
-
intent¶ Whether the request is a proposal, plan, an original order or a reflex order.
-
priority¶ Indicates how quickly the ProcedureRequest should be addressed with respect to other requests.
-
doNotPerform¶ Set this to true if the record is saying that the procedure should NOT be performed.
-
category¶ A code that classifies the procedure for searching, sorting and display purposes (e.g. “Surgical Procedure”).
-
code¶ A code that identifies a particular procedure, diagnostic investigation, or panel of investigations, that have been requested.
-
subject¶ On whom or what the procedure or diagnostic is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
-
context¶ An encounter or episode of care that provides additional information about the healthcare context in which this request is made.
-
occurrenceDateTime¶ The date/time at which the diagnostic testing should occur.
-
occurrencePeriod¶ The date/time at which the diagnostic testing should occur.
-
occurrenceTiming¶ The date/time at which the diagnostic testing should occur.
-
asNeededBoolean¶ If a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example “pain”, “on flare-up”, etc.
-
asNeededCodeableConcept¶ If a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example “pain”, “on flare-up”, etc.
When the request transitioned to being actionable.
-
requester¶ The individual who initiated the request and has responsibility for its activation.
-
performerType¶ Desired type of performer for doing the diagnostic testing.
-
performer¶ The desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc.
-
reasonCode¶ An explanation or justification for why this diagnostic investigation is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInformation.
-
reasonReference¶ Indicates another resource that provides a justification for why this diagnostic investigation is being requested. May relate to the resources referred to in supportingInformation.
-
supportingInfo¶ Additional clinical information about the patient or specimen that may influence the procedure or diagnostics or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as “ask at order entry questions (AOEs)”. This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
-
specimen¶ One or more specimens that the laboratory procedure will use.
-
bodySite¶ Anatomic location where the procedure should be performed. This is the target site.
-
note¶ Any other notes and comments made about the service request. For example, letting provider know that “patient hates needles” or other provider instructions.
-
relevantHistory¶ Key events in the history of the request.
-
-
class
cardea.fhir.ProcedureRequest_Requester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a request for diagnostic investigations, treatments, or operations to be performed.
-
agent¶ The device, practitioner or organization who initiated the request.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
-
class
cardea.fhir.ProcessRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the target, request and response, and action details for an action to be performed by the target on or about existing resources.
-
resourceType¶ This is a ProcessRequest resource
-
identifier¶ The ProcessRequest business identifier.
-
status¶ The status of the resource instance.
-
action¶ The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest.
-
target¶ The organization which is the target of the request.
-
created¶ The date when this resource was created.
-
provider¶ The practitioner who is responsible for the action specified in this request.
-
organization¶ The organization which is responsible for the action speccified in this request.
-
request¶ Reference of resource which is the target or subject of this action.
-
response¶ Reference of a prior response to resource which is the target or subject of this action.
-
nullify¶ If true remove all history excluding audit.
-
reference¶ A reference to supply which authenticates the process.
-
item¶ List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.
-
include¶ Names of resource types to include.
-
exclude¶ Names of resource types to exclude.
-
period¶ A period of time during which the fulfilling resources would have been created.
-
-
class
cardea.fhir.ProcessRequest_Item(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides the target, request and response, and action details for an action to be performed by the target on or about existing resources.
-
sequenceLinkId¶ A service line number.
-
-
class
cardea.fhir.ProcessResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides processing status, errors and notes from the processing of a resource.
-
resourceType¶ This is a ProcessResponse resource
-
identifier¶ The Response business identifier.
-
status¶ The status of the resource instance.
-
created¶ The date when the enclosed suite of services were performed or completed.
-
organization¶ The organization who produced this adjudicated response.
-
request¶ Original request resource reference.
-
outcome¶ Transaction status: error, complete, held.
-
disposition¶ A description of the status of the adjudication or processing.
-
requestProvider¶ The practitioner who is responsible for the services rendered to the patient.
-
requestOrganization¶ The organization which is responsible for the services rendered to the patient.
-
form¶ The form to be used for printing the content.
-
processNote¶ Suite of processing notes or additional requirements if the processing has been held.
-
error¶ Processing errors.
-
communicationRequest¶ Request for additional supporting or authorizing information, such as: documents, images or resources.
-
-
class
cardea.fhir.ProcessResponse_ProcessNote(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis resource provides processing status, errors and notes from the processing of a resource.
-
type¶ The note purpose: Print/Display.
-
text¶ The note text.
-
-
class
cardea.fhir.Provenance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseProvenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.
-
resourceType¶ This is a Provenance resource
-
target¶ The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.
-
period¶ The period during which the activity occurred.
-
recorded¶ The instant of time at which the activity was recorded.
-
policy¶ Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
-
location¶ Where the activity occurred, if relevant.
-
reason¶ The reason that the activity was taking place.
-
activity¶ An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
-
agent¶ An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
-
entity¶ An entity used in this activity.
-
signature¶ A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
-
-
class
cardea.fhir.Provenance_Agent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseProvenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.
-
role¶ The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.
-
whoUri¶ The individual, device or organization that participated in the event.
-
whoReference¶ The individual, device or organization that participated in the event.
-
onBehalfOfUri¶ The individual, device, or organization for whom the change was made.
-
onBehalfOfReference¶ The individual, device, or organization for whom the change was made.
The type of relationship between agents.
-
-
class
cardea.fhir.Provenance_Entity(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseProvenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.
-
role¶ How the entity was used during the activity.
-
whatUri¶ Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.
-
whatReference¶ Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.
-
whatIdentifier¶ Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.
-
agent¶ The entity is attributed to an agent to express the agent’s responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.
-
-
class
cardea.fhir.Quantity(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies.
-
value¶ The value of the measured amount. The value includes an implicit precision in the presentation of the value.
-
comparator¶ How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is “<” , then the real value is < stated value.
-
unit¶ A human-readable form of the unit.
-
system¶ The identification of the system that provides the coded form of the unit.
-
code¶ A computer processable form of the unit in some unit representation system.
-
-
class
cardea.fhir.Questionnaire(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
-
resourceType¶ This is a Questionnaire resource
-
url¶ An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this questionnaire is (or will be) published. The URL SHOULD include the major version of the questionnaire. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the questionnaire.
-
status¶ The status of this questionnaire. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the questionnaire was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.
-
publisher¶ The name of the individual or organization that published the questionnaire.
-
description¶ A free text natural language description of the questionnaire from a consumer’s perspective.
-
purpose¶ Explaination of why this questionnaire is needed and why it has been designed as it has.
-
approvalDate¶ The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate¶ The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn’t change the original approval date.
-
effectivePeriod¶ The period during which the questionnaire content was or is planned to be in active use.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate questionnaire instances.
-
jurisdiction¶ A legal or geographic region in which the questionnaire is intended to be used.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
copyright¶ A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.
-
code¶ An identifier for this question or group of questions in a particular terminology such as LOINC.
-
subjectType¶ The types of subjects that can be the subject of responses created for the questionnaire.
-
item¶ A particular question, question grouping or display text that is part of the questionnaire.
-
-
class
cardea.fhir.Questionnaire_Item(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
-
linkId¶ An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.
-
definition¶ A reference to an [[[ElementDefinition]]] that provides the details for the item. If a definition is provided, then the following element values can be inferred from the definition: * code (ElementDefinition.code) * type (ElementDefinition.type) * required (ElementDefinition.min) * repeats (ElementDefinition.max) * maxLength (ElementDefinition.maxLength) * options (ElementDefinition.binding) Any information provided in these elements on a Questionnaire Item overrides the information from the definition.
-
code¶ A terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers).
-
prefix¶ A short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire.
-
text¶ The name of a section, the text of a question or text content for a display item.
-
type¶ The type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).
-
enableWhen¶ A constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.
-
required¶ An indication, if true, that the item must be present in a “completed” QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.
-
repeats¶ An indication, if true, that the item may occur multiple times in the response, collecting multiple answers answers for questions or multiple sets of answers for groups.
-
readOnly¶ An indication, when true, that the value cannot be changed by a human respondent to the Questionnaire.
-
maxLength¶ The maximum number of characters that are permitted in the answer to be considered a “valid” QuestionnaireResponse.
-
options¶ A reference to a value set containing a list of codes representing permitted answers for a “choice” or “open-choice” question.
-
option¶ One of the permitted answers for a “choice” or “open-choice” question.
-
initialBoolean¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialDecimal¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialInteger¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialDate¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialDateTime¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialTime¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialString¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialUri¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialAttachment¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialCoding¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialQuantity¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
initialReference¶ The value that should be defaulted when initially rendering the questionnaire for user input.
-
item¶ Text, questions and other groups to be nested beneath a question or group.
-
-
class
cardea.fhir.Questionnaire_EnableWhen(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
-
question¶ The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.
-
hasAnswer¶ An indication that this item should be enabled only if the specified question is answered (hasAnswer=true) or not answered (hasAnswer=false).
-
answerBoolean¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerDecimal¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerInteger¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerDate¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerDateTime¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerTime¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerString¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerUri¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerAttachment¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerCoding¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerQuantity¶ An answer that the referenced question must match in order for the item to be enabled.
-
answerReference¶ An answer that the referenced question must match in order for the item to be enabled.
-
-
class
cardea.fhir.Questionnaire_Option(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
-
valueInteger¶ A potential answer that’s allowed as the answer to this question.
-
valueDate¶ A potential answer that’s allowed as the answer to this question.
-
valueTime¶ A potential answer that’s allowed as the answer to this question.
-
valueString¶ A potential answer that’s allowed as the answer to this question.
-
valueCoding¶ A potential answer that’s allowed as the answer to this question.
-
-
class
cardea.fhir.QuestionnaireResponse(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
-
resourceType¶ This is a QuestionnaireResponse resource
-
identifier¶ A business identifier assigned to a particular completed (or partially completed) questionnaire.
-
basedOn¶ The order, proposal or plan that is fulfilled in whole or in part by this QuestionnaireResponse. For example, a ProcedureRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression.
-
parent¶ A procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of.
-
questionnaire¶ The Questionnaire that defines and organizes the questions for which answers are being provided.
-
status¶ The position of the questionnaire response within its overall lifecycle.
-
subject¶ The subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information.
-
context¶ The encounter or episode of care with primary association to the questionnaire response.
The date and/or time that this set of answers were last changed.
Person who received the answers to the questions in the QuestionnaireResponse and recorded them in the system.
-
source¶ The person who answered the questions about the subject.
-
item¶ A group or question item from the original questionnaire for which answers are provided.
-
-
class
cardea.fhir.QuestionnaireResponse_Item(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
-
linkId¶ The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.
-
definition¶ A reference to an [[[ElementDefinition]]] that provides the details for the item.
-
text¶ Text that is displayed above the contents of the group or as the text of the question being answered.
-
subject¶ More specific subject this section’s answers are about, details the subject given in QuestionnaireResponse.
-
answer¶ The respondent’s answer(s) to the question.
-
item¶ Questions or sub-groups nested beneath a question or group.
-
-
class
cardea.fhir.QuestionnaireResponse_Answer(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to.
-
valueBoolean¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueDecimal¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueInteger¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueDate¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueDateTime¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueTime¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueString¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueUri¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueAttachment¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueCoding¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueQuantity¶ The answer (or one of the answers) provided by the respondent to the question.
-
valueReference¶ The answer (or one of the answers) provided by the respondent to the question.
-
item¶ Nested groups and/or questions found within this particular answer.
-
-
class
cardea.fhir.Range(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA set of ordered Quantities defined by a low and high limit.
-
low¶ The low limit. The boundary is inclusive.
-
high¶ The high limit. The boundary is inclusive.
-
-
class
cardea.fhir.Ratio(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA relationship of two Quantity values - expressed as a numerator and a denominator.
-
numerator¶ The value of the numerator.
-
denominator¶ The value of the denominator.
-
-
class
cardea.fhir.Reference(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA reference from one resource to another.
-
reference¶ A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with ‘#’) refer to contained resources.
-
identifier¶ An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
-
display¶ Plain text narrative that identifies the resource in addition to the resource reference.
-
-
class
cardea.fhir.ReferralRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseUsed to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.
-
resourceType¶ This is a ReferralRequest resource
-
identifier¶ Business identifier that uniquely identifies the referral/care transfer request instance.
-
definition¶ A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
-
basedOn¶ Indicates any plans, proposals or orders that this request is intended to satisfy - in whole or in part.
-
replaces¶ Completed or terminated request(s) whose function is taken by this new request.
-
groupIdentifier¶ The business identifier of the logical “grouping” request/order that this referral is a part of.
-
status¶ The status of the authorization/intention reflected by the referral request record.
-
intent¶ Distinguishes the “level” of authorization/demand implicit in this request.
-
type¶ An indication of the type of referral (or where applicable the type of transfer of care) request.
-
priority¶ An indication of the urgency of referral (or where applicable the type of transfer of care) request.
-
serviceRequested¶ The service(s) that is/are requested to be provided to the patient. For example: cardiac pacemaker insertion.
-
subject¶ The patient who is the subject of a referral or transfer of care request.
-
context¶ The encounter at which the request for referral or transfer of care is initiated.
-
occurrenceDateTime¶ The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
-
occurrencePeriod¶ The period of time within which the services identified in the referral/transfer of care is specified or required to occur.
Date/DateTime of creation for draft requests and date of activation for active requests.
-
requester¶ The individual who initiated the request and has responsibility for its activation.
-
specialty¶ Indication of the clinical domain or discipline to which the referral or transfer of care request is sent. For example: Cardiology Gastroenterology Diabetology.
-
recipient¶ The healthcare provider(s) or provider organization(s) who/which is to receive the referral/transfer of care request.
-
reasonCode¶ Description of clinical condition indicating why referral/transfer of care is requested. For example: Pathological Anomalies, Disabled (physical or mental), Behavioral Management.
-
reasonReference¶ Indicates another resource whose existence justifies this request.
-
description¶ The reason element gives a short description of why the referral is being made, the description expands on this to support a more complete clinical summary.
-
supportingInfo¶ Any additional (administrative, financial or clinical) information required to support request for referral or transfer of care. For example: Presenting problems/chief complaints Medical History Family History Alerts Allergy/Intolerance and Adverse Reactions Medications Observations/Assessments (may include cognitive and fundtional assessments) Diagnostic Reports Care Plan.
-
note¶ Comments made about the referral request by any of the participants.
-
relevantHistory¶ Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.
-
-
class
cardea.fhir.ReferralRequest_Requester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseUsed to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organization.
-
agent¶ The device, practitioner, etc. who initiated the request.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
-
class
cardea.fhir.RelatedArtifact(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRelated artifacts such as additional documentation, justification, or bibliographic references.
-
type¶ The type of relationship to the related artifact.
-
display¶ A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.
-
citation¶ A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.
-
url¶ A url for the artifact that can be followed to access the actual content.
-
document¶ The document being referenced, represented as an attachment. This is exclusive with the resource element.
-
resource¶ The related resource, such as a library, value set, profile, or other knowledge resource.
-
-
class
cardea.fhir.RelatedPerson(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseInformation about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
-
resourceType¶ This is a RelatedPerson resource
-
identifier¶ Identifier for a person within a particular scope.
-
active¶ Whether this related person record is in active use.
-
patient¶ The patient this person is related to.
-
relationship¶ The nature of the relationship between a patient and the related person.
-
name¶ A name associated with the person.
-
telecom¶ A contact detail for the person, e.g. a telephone number or an email address.
-
gender¶ Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
-
birthDate¶ The date on which the related person was born.
-
address¶ Address where the related person can be contacted or visited.
-
photo¶ Image of the person.
-
period¶ The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.
-
-
class
cardea.fhir.RequestGroup(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA group of related requests that can be used to capture intended activities that have inter-dependencies such as “give this medication after that one”.
-
resourceType¶ This is a RequestGroup resource
-
identifier¶ Allows a service to provide a unique, business identifier for the request.
-
definition¶ A protocol, guideline, orderset or other definition that is adhered to in whole or in part by this request.
-
basedOn¶ A plan, proposal or order that is fulfilled in whole or in part by this request.
-
replaces¶ Completed or terminated request(s) whose function is taken by this new request.
-
groupIdentifier¶ A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
-
status¶ The current state of the request. For request groups, the status reflects the status of all the requests in the group.
-
intent¶ Indicates the level of authority/intentionality associated with the request and where the request fits into the workflow chain.
-
priority¶ Indicates how quickly the request should be addressed with respect to other requests.
-
subject¶ The subject for which the request group was created.
-
context¶ Describes the context of the request group, if any.
Indicates when the request group was created.
Provides a reference to the author of the request group.
-
reasonCodeableConcept¶ Indicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
-
reasonReference¶ Indicates the reason the request group was created. This is typically provided as a parameter to the evaluation and echoed by the service, although for some use cases, such as subscription- or event-based scenarios, it may provide an indication of the cause for the response.
-
note¶ Provides a mechanism to communicate additional information about the response.
-
action¶ The actions, if any, produced by the evaluation of the artifact.
-
-
class
cardea.fhir.RequestGroup_Action(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA group of related requests that can be used to capture intended activities that have inter-dependencies such as “give this medication after that one”.
-
label¶ A user-visible label for the action.
-
title¶ The title of the action displayed to a user.
-
description¶ A short description of the action used to provide a summary to display to the user.
-
textEquivalent¶ A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that may not be capable of interpreting it dynamically.
-
code¶ A code that provides meaning for the action or action group. For example, a section may have a LOINC code for a the section of a documentation template.
-
documentation¶ Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.
-
condition¶ An expression that describes applicability criteria, or start/stop conditions for the action.
A relationship to another action such as “before” or “30-60 minutes after start of”.
-
timingDateTime¶ An optional value describing when the action should be performed.
-
timingPeriod¶ An optional value describing when the action should be performed.
-
timingDuration¶ An optional value describing when the action should be performed.
-
timingRange¶ An optional value describing when the action should be performed.
-
timingTiming¶ An optional value describing when the action should be performed.
-
participant¶ The participant that should perform or be responsible for this action.
-
type¶ The type of action to perform (create, update, remove).
-
groupingBehavior¶ Defines the grouping behavior for the action and its children.
-
selectionBehavior¶ Defines the selection behavior for the action and its children.
-
requiredBehavior¶ Defines the requiredness behavior for the action.
-
precheckBehavior¶ Defines whether the action should usually be preselected.
-
cardinalityBehavior¶ Defines whether the action can be selected multiple times.
-
resource¶ The resource that is the target of the action (e.g. CommunicationRequest).
-
action¶ Sub actions.
-
-
class
cardea.fhir.RequestGroup_Condition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA group of related requests that can be used to capture intended activities that have inter-dependencies such as “give this medication after that one”.
-
kind¶ The kind of condition.
-
description¶ A brief, natural language description of the condition that effectively communicates the intended semantics.
-
language¶ The media type of the language for the expression.
-
expression¶ An expression that returns true or false, indicating whether or not the condition is satisfied.
-
-
class
cardea.fhir.RequestGroup_RelatedAction(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA group of related requests that can be used to capture intended activities that have inter-dependencies such as “give this medication after that one”.
-
actionId¶ The element id of the action this is related to.
-
relationship¶ The relationship of this action to the related action.
-
offsetDuration¶ A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
-
offsetRange¶ A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
-
-
class
cardea.fhir.ResearchStudy(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.
-
resourceType¶ This is a ResearchStudy resource
-
identifier¶ Identifiers assigned to this research study by the sponsor or other systems.
-
title¶ A short, descriptive user-friendly label for the study.
-
protocol¶ The set of steps expected to be performed as part of the execution of the study.
-
partOf¶ A larger research study of which this particular study is a component or step.
-
status¶ The current state of the study.
-
category¶ Codes categorizing the type of study such as investigational vs. observational, type of blinding, type of randomization, safety vs. efficacy, etc.
-
focus¶ The condition(s), medication(s), food(s), therapy(ies), device(s) or other concerns or interventions that the study is seeking to gain more information about.
-
contact¶ Contact details to assist a user in learning more about or engaging with the study.
Citations, references and other related documents.
-
keyword¶ Key terms to aid in searching for or filtering the study.
-
jurisdiction¶ Indicates a country, state or other region where the study is taking place.
-
description¶ A full description of how the study is being conducted.
-
enrollment¶ Reference to a Group that defines the criteria for and quantity of subjects participating in the study. E.g. ” 200 female Europeans between the ages of 20 and 45 with early onset diabetes”.
-
period¶ Identifies the start date and the expected (or actual, depending on status) end date for the study.
-
sponsor¶ The organization responsible for the execution of the study.
-
principalInvestigator¶ Indicates the individual who has primary oversite of the execution of the study.
-
site¶ Clinic, hospital or other healthcare location that is participating in the study.
-
reasonStopped¶ A description and/or code explaining the premature termination of the study.
-
note¶ Comments made about the event by the performer, subject or other participants.
-
arm¶ Describes an expected sequence of events for one of the participants of a study. E.g. Exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up.
-
-
class
cardea.fhir.ResearchStudy_Arm(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.
-
name¶ Unique, human-readable label for this arm of the study.
-
code¶ Categorization of study arm, e.g. experimental, active comparator, placebo comparater.
-
description¶ A succinct description of the path through the study that would be followed by a subject adhering to this arm.
-
-
class
cardea.fhir.ResearchSubject(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.
-
resourceType¶ This is a ResearchSubject resource
-
identifier¶ Identifiers assigned to this research study by the sponsor or other systems.
-
status¶ The current state of the subject.
-
period¶ The dates the subject began and ended their participation in the study.
-
study¶ Reference to the study the subject is participating in.
-
individual¶ The record of the person or animal who is involved in the study.
-
assignedArm¶ The name of the arm in the study the subject is expected to follow as part of this study.
-
actualArm¶ The name of the arm in the study the subject actually followed as part of this study.
-
consent¶ A record of the patient’s informed agreement to participate in the study.
-
-
class
cardea.fhir.Resource(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThis is the base resource type for everything.
-
id¶ The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
-
meta¶ The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
-
implicitRules¶ A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
-
language¶ The base language in which the resource is written.
-
-
class
cardea.fhir.RiskAssessment(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.
-
resourceType¶ This is a RiskAssessment resource
-
identifier¶ Business identifier assigned to the risk assessment.
-
basedOn¶ A reference to the request that is fulfilled by this risk assessment.
-
parent¶ A reference to a resource that this risk assessment is part of, such as a Procedure.
-
status¶ The status of the RiskAssessment, using the same statuses as an Observation.
-
method¶ The algorithm, process or mechanism used to evaluate the risk.
-
code¶ The type of the risk assessment performed.
-
subject¶ The patient or group the risk assessment applies to.
-
context¶ The encounter where the assessment was performed.
-
occurrenceDateTime¶ The date (and possibly time) the risk assessment was performed.
-
occurrencePeriod¶ The date (and possibly time) the risk assessment was performed.
-
condition¶ For assessments or prognosis specific to a particular condition, indicates the condition being assessed.
-
performer¶ The provider or software application that performed the assessment.
-
reasonCodeableConcept¶ The reason the risk assessment was performed.
-
reasonReference¶ The reason the risk assessment was performed.
-
basis¶ Indicates the source data considered as part of the assessment (FamilyHistory, Observations, Procedures, Conditions, etc.).
-
prediction¶ Describes the expected outcome for the subject.
-
mitigation¶ A description of the steps that might be taken to reduce the identified risk(s).
-
comment¶ Additional comments about the risk assessment.
-
-
class
cardea.fhir.RiskAssessment_Prediction(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome.
-
outcome¶ One of the potential outcomes for the patient (e.g. remission, death, a particular condition).
-
probabilityDecimal¶ How likely is the outcome (in the specified timeframe).
-
probabilityRange¶ How likely is the outcome (in the specified timeframe).
-
qualitativeRisk¶ How likely is the outcome (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, high).
-
relativeRisk¶ Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk.).
-
whenPeriod¶ Indicates the period of time or age range of the subject to which the specified probability applies.
-
whenRange¶ Indicates the period of time or age range of the subject to which the specified probability applies.
-
rationale¶ Additional information explaining the basis for the prediction.
-
-
class
cardea.fhir.SampledData(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data.
-
origin¶ The base quantity that a measured value of zero represents. In addition, this provides the units of the entire measurement series.
-
period¶ The length of time between sampling times, measured in milliseconds.
-
factor¶ A correction factor that is applied to the sampled data points before they are added to the origin.
-
lowerLimit¶ The lower limit of detection of the measured points. This is needed if any of the data points have the value “L” (lower than detection limit).
-
upperLimit¶ The upper limit of detection of the measured points. This is needed if any of the data points have the value “U” (higher than detection limit).
-
dimensions¶ The number of sample points at each time point. If this value is greater than one, then the dimensions will be interlaced - all the sample points for a point in time will be recorded at once.
-
data¶ A series of data points which are decimal values separated by a single space (character u20). The special values “E” (error), “L” (below detection limit) and “U” (above detection limit) can also be used in place of a decimal value.
-
-
class
cardea.fhir.Schedule(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA container for slots of time that may be available for booking appointments.
-
resourceType¶ This is a Schedule resource
-
identifier¶ External Ids for this item.
-
active¶ Whether this schedule record is in active use, or should not be used (such as was entered in error).
-
serviceCategory¶ A broad categorisation of the service that is to be performed during this appointment.
-
serviceType¶ The specific service that is to be performed during this appointment.
-
specialty¶ The specialty of a practitioner that would be required to perform the service requested in this appointment.
-
actor¶ The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson.
-
planningHorizon¶ The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization’s planning horizon; the interval for which they are currently accepting appointments. This does not define a “template” for planning outside these dates.
-
comment¶ Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.
-
-
class
cardea.fhir.SearchParameter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA search parameter that defines a named search item that can be used to search/filter on a resource.
-
resourceType¶ This is a SearchParameter resource
-
url¶ An absolute URI that is used to identify this search parameter when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this search parameter is (or will be) published. The URL SHOULD include the major version of the search parameter. For more information see [Technical and Business Versions](resource.html#versions).
-
version¶ The identifier that is used to identify this version of the search parameter when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the search parameter author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the search parameter. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
status¶ The status of this search parameter. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this search parameter is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the search parameter was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.
-
publisher¶ The name of the individual or organization that published the search parameter.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate search parameter instances.
-
jurisdiction¶ A legal or geographic region in which the search parameter is intended to be used.
-
purpose¶ Explaination of why this search parameter is needed and why it has been designed as it has.
-
code¶ The code used in the URL or the parameter name in a parameters resource for this search parameter.
-
base¶ The base resource type(s) that this search parameter can be used against.
-
type¶ The type of value a search parameter refers to, and how the content is interpreted.
-
derivedFrom¶ Where this search parameter is originally defined. If a derivedFrom is provided, then the details in the search parameter must be consistent with the definition from which it is defined. I.e. the parameter should have the same meaning, and (usually) the functionality should be a proper subset of the underlying search parameter.
-
description¶ A free text natural language description of the search parameter from a consumer’s perspective. and how it used.
-
expression¶ A FHIRPath expression that returns a set of elements for the search parameter.
-
xpath¶ An XPath expression that returns a set of elements for the search parameter.
-
xpathUsage¶ How the search parameter relates to the set of elements returned by evaluating the xpath query.
-
target¶ Types of resource (if a resource is referenced).
-
comparator¶ Comparators supported for the search parameter.
-
modifier¶ A modifier supported for the search parameter.
-
chain¶ Contains the names of any search parameters which may be chained to the containing search parameter. Chained parameters may be added to search parameters of type reference, and specify that resources will only be returned if they contain a reference to a resource which matches the chained parameter value. Values for this field should be drawn from SearchParameter.code for a parameter on the target resource type.
-
component¶ Used to define the parts of a composite search parameter.
-
-
class
cardea.fhir.SearchParameter_Component(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA search parameter that defines a named search item that can be used to search/filter on a resource.
-
definition¶ The definition of the search parameter that describes this part.
-
expression¶ A sub-expression that defines how to extract values for this component from the output of the main SearchParameter.expression.
-
-
class
cardea.fhir.Sequence(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRaw data describing a biological sequence.
-
resourceType¶ This is a Sequence resource
-
identifier¶ A unique identifier for this particular sequence instance. This is a FHIR-defined id.
-
type¶ Amino Acid Sequence/ DNA Sequence / RNA Sequence.
-
coordinateSystem¶ Whether the sequence is numbered starting at 0 (0-based numbering or coordinates, inclusive start, exclusive end) or starting at 1 (1-based numbering, inclusive start and inclusive end).
-
patient¶ The patient whose sequencing results are described by this resource.
-
specimen¶ Specimen used for sequencing.
-
device¶ The method for sequencing, for example, chip information.
-
performer¶ The organization or lab that should be responsible for this result.
-
quantity¶ The number of copies of the seqeunce of interest. (RNASeq).
-
referenceSeq¶ A sequence that is used as a reference to describe variants that are present in a sequence analyzed.
-
variant¶ The definition of variant here originates from Sequence ontology ([variant_of](http://www.sequenceontology.org/browser/current_svn/term/variant_of)). This element can represent amino acid or nucleic sequence change(including insertion,deletion,SNP,etc.) It can represent some complex mutation or segment variation with the assist of CIGAR string.
-
observedSeq¶ Sequence that was observed. It is the result marked by referenceSeq along with variant records on referenceSeq. This shall starts from referenceSeq.windowStart and end by referenceSeq.windowEnd.
-
quality¶ An experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score ([SO:0001686](http://www.sequenceontology.org/browser/current_svn/term/SO:0001686)).
-
readCoverage¶ Coverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence.
-
repository¶ Configurations of the external repository. The repository shall store target’s observedSeq or records related with target’s observedSeq.
-
pointer¶ Pointer to next atomic sequence which at most contains one variant.
-
-
class
cardea.fhir.Sequence_ReferenceSeq(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRaw data describing a biological sequence.
-
chromosome¶ Structural unit composed of a nucleic acid molecule which controls its own replication through the interaction of specific proteins at one or more origins of replication ([SO:0000340](http://www.sequenceontology.org/browser/current_svn/term/SO:0000340)).
-
genomeBuild¶ The Genome Build used for reference, following GRCh build versions e.g. ‘GRCh 37’. Version number must be included if a versioned release of a primary build was used.
-
referenceSeqId¶ Reference identifier of reference sequence submitted to NCBI. It must match the type in the Sequence.type field. For example, the prefix, “NG_” identifies reference sequence for genes, “NM_” for messenger RNA transcripts, and “NP_” for amino acid sequences.
-
referenceSeqPointer¶ A Pointer to another Sequence entity as reference sequence.
-
referenceSeqString¶ A string like “ACGT”.
-
strand¶ Directionality of DNA sequence. Available values are “1” for the plus strand (5’ to 3’)/Watson/Sense/positive and “-1” for the minus strand(3’ to 5’)/Crick/Antisense/negative.
-
windowStart¶ Start position of the window on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.
-
windowEnd¶ End position of the window on the reference sequence. If the coordinate system is 0-based then end is is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.
-
-
class
cardea.fhir.Sequence_Variant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRaw data describing a biological sequence.
-
start¶ Start position of the variant on the reference sequence.If the coordinate system is either 0-based or 1-based, then start position is inclusive.
-
end¶ End position of the variant on the reference sequence.If the coordinate system is 0-based then end is is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.
-
observedAllele¶ An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the observed sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.
-
referenceAllele¶ An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the reference sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end.
-
cigar¶ Extended CIGAR string for aligning the sequence with reference bases. See detailed documentation [here](http://support.illumina.com/help/SequencingAnalysisWorkflow/Content/Vault/Informatics/Sequencing_Analysis/CASAVA/swSEQ_mCA_ExtendedCIGARFormat.htm).
-
variantPointer¶ A pointer to an Observation containing variant information.
-
-
class
cardea.fhir.Sequence_Quality(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRaw data describing a biological sequence.
-
type¶ INDEL / SNP / Undefined variant.
-
standardSequence¶ Gold standard sequence used for comparing against.
-
start¶ Start position of the sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.
-
end¶ End position of the sequence.If the coordinate system is 0-based then end is is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position.
-
score¶ The score of an experimentally derived feature such as a p-value ([SO:0001685](http://www.sequenceontology.org/browser/current_svn/term/SO:0001685)).
-
method¶ Which method is used to get sequence quality.
-
truthTP¶ True positives, from the perspective of the truth data, i.e. the number of sites in the Truth Call Set for which there are paths through the Query Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.
-
queryTP¶ True positives, from the perspective of the query data, i.e. the number of sites in the Query Call Set for which there are paths through the Truth Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event.
-
truthFN¶ False negatives, i.e. the number of sites in the Truth Call Set for which there is no path through the Query Call Set that is consistent with all of the alleles at this site, or sites for which there is an inaccurate genotype call for the event. Sites with correct variant but incorrect genotype are counted here.
-
queryFP¶ False positives, i.e. the number of sites in the Query Call Set for which there is no path through the Truth Call Set that is consistent with this site. Sites with correct variant but incorrect genotype are counted here.
-
gtFP¶ The number of false positives where the non-REF alleles in the Truth and Query Call Sets match (i.e. cases where the truth is 1/1 and the query is 0/1 or similar).
-
precision¶ QUERY.TP / (QUERY.TP + QUERY.FP).
-
recall¶ TRUTH.TP / (TRUTH.TP + TRUTH.FN).
-
fScore¶ Harmonic mean of Recall and Precision, computed as: 2 * precision * recall / (precision + recall).
-
-
class
cardea.fhir.Sequence_Repository(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRaw data describing a biological sequence.
-
type¶ Click and see / RESTful API / Need login to see / RESTful API with authentication / Other ways to see resource.
-
url¶ URI of an external repository which contains further details about the genetics data.
-
name¶ URI of an external repository which contains further details about the genetics data.
-
datasetId¶ Id of the variant in this external repository. The server will understand how to use this id to call for more info about datasets in external repository.
-
variantsetId¶ Id of the variantset in this external repository. The server will understand how to use this id to call for more info about variantsets in external repository.
-
readsetId¶ Id of the read in this external repository.
-
-
class
cardea.fhir.ServiceDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe ServiceDefinition describes a unit of decision support functionality that is made available as a service, such as immunization modules or drug-drug interaction checking.
-
resourceType¶ This is a ServiceDefinition resource
-
url¶ An absolute URI that is used to identify this service definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this service definition is (or will be) published. The URL SHOULD include the major version of the service definition. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this service definition when it is represented in other formats, or referenced in a specification, model, design or an instance. This is used for CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.
-
version¶ The identifier that is used to identify this version of the service definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the service definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the service definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the service definition.
-
status¶ The status of this service definition. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this service definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the service definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the service definition changes.
-
publisher¶ The name of the individual or organization that published the service definition.
-
description¶ A free text natural language description of the service definition from a consumer’s perspective.
-
purpose¶ Explaination of why this service definition is needed and why it has been designed as it has.
-
usage¶ A detailed description of how the module is used from a clinical perspective.
-
approvalDate¶ The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate¶ The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn’t change the original approval date.
-
effectivePeriod¶ The period during which the service definition content was or is planned to be in active use.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate service definition instances.
-
jurisdiction¶ A legal or geographic region in which the service definition is intended to be used.
-
topic¶ Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
-
contributor¶ A contributor to the content of the module, including authors, editors, reviewers, and endorsers.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
copyright¶ A copyright statement relating to the service definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the service definition.
Related resources such as additional documentation, justification, or bibliographic references.
-
trigger¶ The trigger element defines when the rule should be invoked. This information is used by consumers of the rule to determine how to integrate the rule into a specific workflow.
-
dataRequirement¶ Data requirements are a machine processable description of the data required by the module in order to perform a successful evaluation.
-
operationDefinition¶ A reference to the operation that is used to invoke this service.
-
-
class
cardea.fhir.Signature(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA digital signature along with supporting context. The signature may be electronic/cryptographic in nature, or a graphical image representing a hand-written signature, or a signature process. Different signature approaches have different utilities.
-
type¶ An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document.
-
when¶ When the digital signature was signed.
-
whoUri¶ A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).
-
whoReference¶ A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).
-
onBehalfOfUri¶ A reference to an application-usable description of the identity that is represented by the signature.
-
onBehalfOfReference¶ A reference to an application-usable description of the identity that is represented by the signature.
-
contentType¶ A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jwt for JWT, and image/* for a graphical image of a signature, etc.
-
blob¶ The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
-
-
class
cardea.fhir.Slot(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA slot of time on a schedule that may be available for booking appointments.
-
resourceType¶ This is a Slot resource
-
identifier¶ External Ids for this item.
-
serviceCategory¶ A broad categorisation of the service that is to be performed during this appointment.
-
serviceType¶ The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.
-
specialty¶ The specialty of a practitioner that would be required to perform the service requested in this appointment.
-
appointmentType¶ The style of appointment or patient that may be booked in the slot (not service type).
-
schedule¶ The schedule resource that this slot defines an interval of status information.
-
status¶ busy | free | busy-unavailable | busy-tentative | entered-in-error.
-
start¶ Date/Time that the slot is to begin.
-
end¶ Date/Time that the slot is to conclude.
-
overbooked¶ This slot has already been overbooked, appointments are unlikely to be accepted for this time.
-
comment¶ Comments on the slot to describe any extended information. Such as custom constraints on the slot.
-
-
class
cardea.fhir.Specimen(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA sample to be used for analysis.
-
resourceType¶ This is a Specimen resource
-
identifier¶ Id for specimen.
-
accessionIdentifier¶ The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
-
status¶ The availability of the specimen.
-
type¶ The kind of material that forms the specimen.
-
subject¶ Where the specimen came from. This may be from the patient(s) or from the environment or a device.
-
receivedTime¶ Time when specimen was received for processing or testing.
-
parent¶ Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
-
request¶ Details concerning a test or procedure request that required a specimen to be collected.
-
collection¶ Details concerning the specimen collection.
-
processing¶ Details concerning processing and processing steps for the specimen.
-
container¶ The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
-
note¶ To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
-
-
class
cardea.fhir.Specimen_Collection(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA sample to be used for analysis.
-
collector¶ Person who collected the specimen.
-
collectedDateTime¶ Time when specimen was collected from subject - the physiologically relevant time.
-
collectedPeriod¶ Time when specimen was collected from subject - the physiologically relevant time.
-
quantity¶ The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.
-
method¶ A coded value specifying the technique that is used to perform the procedure.
-
bodySite¶ Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.
-
-
class
cardea.fhir.Specimen_Processing(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA sample to be used for analysis.
-
description¶ Textual description of procedure.
-
procedure¶ A coded value specifying the procedure used to process the specimen.
-
additive¶ Material used in the processing step.
-
timeDateTime¶ A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.
-
timePeriod¶ A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.
-
-
class
cardea.fhir.Specimen_Container(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA sample to be used for analysis.
-
identifier¶ Id for container. There may be multiple; a manufacturer’s bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.
-
description¶ Textual description of the container.
-
type¶ The type of container associated with the specimen (e.g. slide, aliquot, etc.).
-
capacity¶ The capacity (volume or other measure) the container may contain.
-
specimenQuantity¶ The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.
-
additiveCodeableConcept¶ Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
-
additiveReference¶ Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.
-
-
class
cardea.fhir.StructureDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
-
resourceType¶ This is a StructureDefinition resource
-
url¶ An absolute URI that is used to identify this structure definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure definition is (or will be) published. The URL SHOULD include the major version of the structure definition. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this structure definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the structure definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the structure definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the structure definition.
-
status¶ The status of this structure definition. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this structure definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the structure definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure definition changes.
-
publisher¶ The name of the individual or organization that published the structure definition.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the structure definition from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate structure definition instances.
-
jurisdiction¶ A legal or geographic region in which the structure definition is intended to be used.
-
purpose¶ Explaination of why this structure definition is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the structure definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure definition.
-
keyword¶ A set of key words or terms from external terminologies that may be used to assist with indexing and searching of templates.
-
fhirVersion¶ The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.1 for this version.
-
mapping¶ An external specification that the content is mapped to.
-
kind¶ Defines the kind of structure that this definition is describing.
-
abstract¶ Whether structure this definition describes is abstract or not - that is, whether the structure is not intended to be instantiated. For Resources and Data types, abstract types will never be exchanged between systems.
-
contextType¶ If this is an extension, Identifies the context within FHIR resources where the extension can be used.
-
context¶ Identifies the types of resource or data type elements to which the extension can be applied.
-
contextInvariant¶ A set of rules as Fluent Invariants about when the extension can be used (e.g. co-occurrence variants for the extension).
-
type¶ The type this structure describes. If the derivation kind is ‘specialization’ then this is the master definition for a type, and there is always one of these (a data type, an extension, a resource, including abstract ones). Otherwise the structure definition is a constraint on the stated type (and in this case, the type cannot be an abstract type).
-
baseDefinition¶ An absolute URI that is the base structure from which this type is derived, either by specialization or constraint.
-
derivation¶ How the type relates to the baseDefinition.
-
snapshot¶ A snapshot view is expressed in a stand alone form that can be used and interpreted without considering the base StructureDefinition.
-
differential¶ A differential view is expressed relative to the base StructureDefinition - a statement of differences that it applies.
-
-
class
cardea.fhir.StructureDefinition_Mapping(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
-
identity¶ An Internal id that is used to identify this mapping set when specific mappings are made.
-
uri¶ An absolute URI that identifies the specification that this mapping is expressed to.
-
name¶ A name for the specification that is being mapped to.
-
comment¶ Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.
-
-
class
cardea.fhir.StructureDefinition_Snapshot(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
-
element¶ Captures constraints on each element within the resource.
-
-
class
cardea.fhir.StructureDefinition_Differential(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
-
element¶ Captures constraints on each element within the resource.
-
-
class
cardea.fhir.StructureMap(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
resourceType¶ This is a StructureMap resource
-
url¶ An absolute URI that is used to identify this structure map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this structure map is (or will be) published. The URL SHOULD include the major version of the structure map. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this structure map when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the structure map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the structure map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the structure map. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the structure map.
-
status¶ The status of this structure map. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this structure map is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the structure map was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the structure map changes.
-
publisher¶ The name of the individual or organization that published the structure map.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the structure map from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate structure map instances.
-
jurisdiction¶ A legal or geographic region in which the structure map is intended to be used.
-
purpose¶ Explaination of why this structure map is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the structure map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the structure map.
-
structure¶ A structure definition used by this map. The structure definition may describe instances that are converted, or the instances that are produced.
-
import¶ Other maps used by this map (canonical URLs).
-
group¶ Organizes the mapping into managable chunks for human review/ease of maintenance.
-
-
class
cardea.fhir.StructureMap_Structure(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
url¶ The canonical URL that identifies the structure.
-
mode¶ How the referenced structure is used in this mapping.
-
alias¶ The name used for this type in the map.
-
documentation¶ Documentation that describes how the structure is used in the mapping.
-
-
class
cardea.fhir.StructureMap_Group(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
name¶ A unique name for the group for the convenience of human readers.
-
extends¶ Another group that this group adds rules to.
-
typeMode¶ If this is the default rule set to apply for thie source type, or this combination of types.
-
documentation¶ Additional supporting documentation that explains the purpose of the group and the types of mappings within it.
-
input¶ A name assigned to an instance of data. The instance must be provided when the mapping is invoked.
-
rule¶ Transform Rule from source to target.
-
-
class
cardea.fhir.StructureMap_Input(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
name¶ Name for this instance of data.
-
type¶ Type for this instance of data.
-
mode¶ Mode for this instance of data.
-
documentation¶ Documentation for this instance of data.
-
-
class
cardea.fhir.StructureMap_Rule(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
name¶ Name of the rule for internal references.
-
source¶ Source inputs to the mapping.
-
target¶ Content to create because of this mapping rule.
-
rule¶ Rules contained in this rule.
-
dependent¶ Which other rules to apply in the context of this rule.
-
documentation¶ Documentation for this instance of data.
-
-
class
cardea.fhir.StructureMap_Source(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
context¶ Type or variable this rule applies to.
-
min¶ Specified minimum cardinality for the element. This is optional; if present, it acts an implicit check on the input content.
-
max¶ Specified maximum cardinality for the element - a number or a “*”. This is optional; if present, it acts an implicit check on the input content (* just serves as documentation; it’s the default value).
-
type¶ Specified type for the element. This works as a condition on the mapping - use for polymorphic elements.
-
defaultValueBoolean¶ A value to use if there is no existing value in the source object.
-
defaultValueInteger¶ A value to use if there is no existing value in the source object.
-
defaultValueDecimal¶ A value to use if there is no existing value in the source object.
-
defaultValueBase64Binary¶ A value to use if there is no existing value in the source object.
-
defaultValueInstant¶ A value to use if there is no existing value in the source object.
-
defaultValueString¶ A value to use if there is no existing value in the source object.
-
defaultValueUri¶ A value to use if there is no existing value in the source object.
-
defaultValueDate¶ A value to use if there is no existing value in the source object.
-
defaultValueDateTime¶ A value to use if there is no existing value in the source object.
-
defaultValueTime¶ A value to use if there is no existing value in the source object.
-
defaultValueCode¶ A value to use if there is no existing value in the source object.
-
defaultValueOid¶ A value to use if there is no existing value in the source object.
-
defaultValueUuid¶ A value to use if there is no existing value in the source object.
-
defaultValueId¶ A value to use if there is no existing value in the source object.
-
defaultValueUnsignedInt¶ A value to use if there is no existing value in the source object.
-
defaultValuePositiveInt¶ A value to use if there is no existing value in the source object.
-
defaultValueMarkdown¶ A value to use if there is no existing value in the source object.
-
defaultValueElement¶ A value to use if there is no existing value in the source object.
-
defaultValueExtension¶ A value to use if there is no existing value in the source object.
-
defaultValueBackboneElement¶ A value to use if there is no existing value in the source object.
-
defaultValueNarrative¶ A value to use if there is no existing value in the source object.
-
defaultValueAnnotation¶ A value to use if there is no existing value in the source object.
-
defaultValueAttachment¶ A value to use if there is no existing value in the source object.
-
defaultValueIdentifier¶ A value to use if there is no existing value in the source object.
-
defaultValueCodeableConcept¶ A value to use if there is no existing value in the source object.
-
defaultValueCoding¶ A value to use if there is no existing value in the source object.
-
defaultValueQuantity¶ A value to use if there is no existing value in the source object.
-
defaultValueDuration¶ A value to use if there is no existing value in the source object.
-
defaultValueSimpleQuantity¶ A value to use if there is no existing value in the source object.
-
defaultValueDistance¶ A value to use if there is no existing value in the source object.
-
defaultValueCount¶ A value to use if there is no existing value in the source object.
-
defaultValueMoney¶ A value to use if there is no existing value in the source object.
-
defaultValueAge¶ A value to use if there is no existing value in the source object.
-
defaultValueRange¶ A value to use if there is no existing value in the source object.
-
defaultValuePeriod¶ A value to use if there is no existing value in the source object.
-
defaultValueRatio¶ A value to use if there is no existing value in the source object.
-
defaultValueReference¶ A value to use if there is no existing value in the source object.
-
defaultValueSampledData¶ A value to use if there is no existing value in the source object.
-
defaultValueSignature¶ A value to use if there is no existing value in the source object.
-
defaultValueHumanName¶ A value to use if there is no existing value in the source object.
-
defaultValueAddress¶ A value to use if there is no existing value in the source object.
-
defaultValueContactPoint¶ A value to use if there is no existing value in the source object.
-
defaultValueTiming¶ A value to use if there is no existing value in the source object.
-
defaultValueMeta¶ A value to use if there is no existing value in the source object.
-
defaultValueElementDefinition¶ A value to use if there is no existing value in the source object.
-
defaultValueContactDetail¶ A value to use if there is no existing value in the source object.
-
defaultValueContributor¶ A value to use if there is no existing value in the source object.
-
defaultValueDosage¶ A value to use if there is no existing value in the source object.
-
defaultValueRelatedArtifact¶ A value to use if there is no existing value in the source object.
-
defaultValueUsageContext¶ A value to use if there is no existing value in the source object.
-
defaultValueDataRequirement¶ A value to use if there is no existing value in the source object.
-
defaultValueParameterDefinition¶ A value to use if there is no existing value in the source object.
-
defaultValueTriggerDefinition¶ A value to use if there is no existing value in the source object.
-
element¶ Optional field for this source.
-
listMode¶ How to handle the list mode for this element.
-
variable¶ Named context for field, if a field is specified.
-
condition¶ FHIRPath expression - must be true or the rule does not apply.
-
check¶ FHIRPath expression - must be true or the mapping engine throws an error instead of completing.
-
-
class
cardea.fhir.StructureMap_Target(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
context¶ Type or variable this rule applies to.
-
contextType¶ How to interpret the context.
-
element¶ Field to create in the context.
-
variable¶ Named context for field, if desired, and a field is specified.
-
listMode¶ If field is a list, how to manage the list.
-
listRuleId¶ Internal rule reference for shared list items.
-
transform¶ How the data is copied / created.
-
parameter¶ Parameters to the transform.
-
-
class
cardea.fhir.StructureMap_Parameter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
valueId¶ Parameter value - variable or literal.
-
valueString¶ Parameter value - variable or literal.
-
valueBoolean¶ Parameter value - variable or literal.
-
valueInteger¶ Parameter value - variable or literal.
-
valueDecimal¶ Parameter value - variable or literal.
-
-
class
cardea.fhir.StructureMap_Dependent(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA Map of relationships between 2 structures that can be used to transform data.
-
name¶ Name of a rule or group to apply.
-
variable¶ Variable to pass to the rule or group.
-
-
class
cardea.fhir.Subscription(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe subscription resource is used to define a push based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined “channel” so that another system is able to take an appropriate action.
-
resourceType¶ This is a Subscription resource
-
status¶ The status of the subscription, which marks the server state for managing the subscription.
-
contact¶ Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
-
end¶ The time for the server to turn the subscription off.
-
reason¶ A description of why this subscription is defined.
-
criteria¶ The rules that the server should use to determine when to generate notifications for this subscription.
-
error¶ A record of the last error that occurred when the server processed a notification.
-
channel¶ Details where to send notifications when resources are received that meet the criteria.
-
tag¶ A tag to add to any resource that matches the criteria, after the subscription is processed.
-
-
class
cardea.fhir.Subscription_Channel(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseThe subscription resource is used to define a push based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined “channel” so that another system is able to take an appropriate action.
-
type¶ The type of channel to send notifications on.
-
endpoint¶ The uri that describes the actual end-point to send messages to.
-
payload¶ The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification.
-
header¶ Additional headers / information to send as part of the notification.
-
-
class
cardea.fhir.Substance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA homogeneous material with a definite composition.
-
resourceType¶ This is a Substance resource
-
identifier¶ Unique identifier for the substance.
-
status¶ A code to indicate if the substance is actively used.
-
category¶ A code that classifies the general type of substance. This is used for searching, sorting and display purposes.
-
code¶ A code (or set of codes) that identify this substance.
-
description¶ A description of the substance - its appearance, handling requirements, and other usage notes.
-
instance¶ Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.
-
ingredient¶ A substance can be composed of other substances.
-
-
class
cardea.fhir.Substance_Instance(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA homogeneous material with a definite composition.
-
identifier¶ Identifier associated with the package/container (usually a label affixed directly).
-
expiry¶ When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.
-
quantity¶ The amount of the substance.
-
-
class
cardea.fhir.Substance_Ingredient(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA homogeneous material with a definite composition.
-
quantity¶ The amount of the ingredient in the substance - a concentration ratio.
-
substanceCodeableConcept¶ Another substance that is a component of this substance.
-
substanceReference¶ Another substance that is a component of this substance.
-
-
class
cardea.fhir.SupplyDelivery(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRecord of delivery of what is supplied.
-
resourceType¶ This is a SupplyDelivery resource
-
identifier¶ Identifier assigned by the dispensing facility when the item(s) is dispensed.
-
basedOn¶ A plan, proposal or order that is fulfilled in whole or in part by this event.
-
partOf¶ A larger event of which this particular event is a component or step.
-
status¶ A code specifying the state of the dispense event.
-
patient¶ A link to a resource representing the person whom the delivered item is for.
-
type¶ Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.
-
suppliedItem¶ The item that is being delivered or has been supplied.
-
occurrenceDateTime¶ The date or time(s) the activity occurred.
-
occurrencePeriod¶ The date or time(s) the activity occurred.
-
occurrenceTiming¶ The date or time(s) the activity occurred.
-
supplier¶ The individual responsible for dispensing the medication, supplier or device.
-
destination¶ Identification of the facility/location where the Supply was shipped to, as part of the dispense event.
-
receiver¶ Identifies the person who picked up the Supply.
-
-
class
cardea.fhir.SupplyDelivery_SuppliedItem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseRecord of delivery of what is supplied.
-
quantity¶ The amount of supply that has been dispensed. Includes unit of measure.
-
itemCodeableConcept¶ Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
-
itemReference¶ Identifies the medication, substance or device being dispensed. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
-
-
class
cardea.fhir.SupplyRequest(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a request for a medication, substance or device used in the healthcare setting.
-
resourceType¶ This is a SupplyRequest resource
-
identifier¶ Unique identifier for this supply request.
-
status¶ Status of the supply request.
-
category¶ Category of supply, e.g. central, non-stock, etc. This is used to support work flows associated with the supply process.
-
priority¶ Indicates how quickly this SupplyRequest should be addressed with respect to other requests.
-
orderedItem¶ The item being requested.
-
occurrenceDateTime¶ When the request should be fulfilled.
-
occurrencePeriod¶ When the request should be fulfilled.
-
occurrenceTiming¶ When the request should be fulfilled.
When the request was made.
-
requester¶ The individual who initiated the request and has responsibility for its activation.
-
supplier¶ Who is intended to fulfill the request.
-
reasonCodeableConcept¶ Why the supply item was requested.
-
reasonReference¶ Why the supply item was requested.
-
deliverFrom¶ Where the supply is expected to come from.
-
deliverTo¶ Where the supply is destined to go.
-
-
class
cardea.fhir.SupplyRequest_OrderedItem(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a request for a medication, substance or device used in the healthcare setting.
-
quantity¶ The amount that is being ordered of the indicated item.
-
itemCodeableConcept¶ The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
-
itemReference¶ The item that is requested to be supplied. This is either a link to a resource representing the details of the item or a code that identifies the item from a known list.
-
-
class
cardea.fhir.SupplyRequest_Requester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA record of a request for a medication, substance or device used in the healthcare setting.
-
agent¶ The device, practitioner, etc. who initiated the request.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of.
-
-
class
cardea.fhir.Task(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA task to be performed.
-
resourceType¶ This is a Task resource
-
identifier¶ The business identifier for this task.
-
definitionUri¶ A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.
-
definitionReference¶ A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc.
-
basedOn¶ BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a “request” resource such as a ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the “request” resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.
-
groupIdentifier¶ An identifier that links together multiple tasks and other requests that were created in the same context.
-
partOf¶ Task that this particular task is part of.
-
status¶ The current status of the task.
-
statusReason¶ An explanation as to why this task is held, failed, was refused, etc.
-
businessStatus¶ Contains business-specific nuances of the business state.
-
intent¶ Indicates the “level” of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.
-
priority¶ Indicates how quickly the Task should be addressed with respect to other requests.
-
code¶ A name or code (or both) briefly describing what the task involves.
-
description¶ A free-text description of what is to be performed.
-
focus¶ The request being actioned or the resource being manipulated by this task.
-
for¶ The entity who benefits from the performance of the service specified in the task (e.g., the patient).
-
context¶ The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
-
executionPeriod¶ Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).
The date and time this task was created.
-
lastModified¶ The date and time of last modification to this task.
-
requester¶ The creator of the task.
-
performerType¶ The type of participant that can execute the task.
-
owner¶ Individual organization or Device currently responsible for task execution.
-
reason¶ A description or code indicating why this task needs to be performed.
-
note¶ Free-text information captured about the task as it progresses.
-
relevantHistory¶ Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.
-
restriction¶ If the Task.focus is a request resource and the task is seeking fulfillment (i.e is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
-
input¶ Additional information that may be needed in the execution of the task.
-
output¶ Outputs produced by the Task.
-
-
class
cardea.fhir.Task_Requester(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA task to be performed.
-
agent¶ The device, practitioner, etc. who initiated the task.
-
onBehalfOf¶ The organization the device or practitioner was acting on behalf of when they initiated the task.
-
-
class
cardea.fhir.Task_Restriction(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA task to be performed.
-
repetitions¶ Indicates the number of times the requested action should occur.
-
period¶ Over what time-period is fulfillment sought.
-
recipient¶ For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought?
-
-
class
cardea.fhir.Task_Input(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA task to be performed.
-
type¶ A code or description indicating how the input is intended to be used as part of the task execution.
-
valueBoolean¶ The value of the input parameter as a basic type.
-
valueInteger¶ The value of the input parameter as a basic type.
-
valueDecimal¶ The value of the input parameter as a basic type.
-
valueBase64Binary¶ The value of the input parameter as a basic type.
-
valueInstant¶ The value of the input parameter as a basic type.
-
valueString¶ The value of the input parameter as a basic type.
-
valueUri¶ The value of the input parameter as a basic type.
-
valueDate¶ The value of the input parameter as a basic type.
-
valueDateTime¶ The value of the input parameter as a basic type.
-
valueTime¶ The value of the input parameter as a basic type.
-
valueCode¶ The value of the input parameter as a basic type.
-
valueOid¶ The value of the input parameter as a basic type.
-
valueUuid¶ The value of the input parameter as a basic type.
-
valueId¶ The value of the input parameter as a basic type.
-
valueUnsignedInt¶ The value of the input parameter as a basic type.
-
valuePositiveInt¶ The value of the input parameter as a basic type.
-
valueMarkdown¶ The value of the input parameter as a basic type.
-
valueElement¶ The value of the input parameter as a basic type.
-
valueExtension¶ The value of the input parameter as a basic type.
-
valueBackboneElement¶ The value of the input parameter as a basic type.
-
valueNarrative¶ The value of the input parameter as a basic type.
-
valueAnnotation¶ The value of the input parameter as a basic type.
-
valueAttachment¶ The value of the input parameter as a basic type.
-
valueIdentifier¶ The value of the input parameter as a basic type.
-
valueCodeableConcept¶ The value of the input parameter as a basic type.
-
valueCoding¶ The value of the input parameter as a basic type.
-
valueQuantity¶ The value of the input parameter as a basic type.
-
valueDuration¶ The value of the input parameter as a basic type.
-
valueSimpleQuantity¶ The value of the input parameter as a basic type.
-
valueDistance¶ The value of the input parameter as a basic type.
-
valueCount¶ The value of the input parameter as a basic type.
-
valueMoney¶ The value of the input parameter as a basic type.
-
valueAge¶ The value of the input parameter as a basic type.
-
valueRange¶ The value of the input parameter as a basic type.
-
valuePeriod¶ The value of the input parameter as a basic type.
-
valueRatio¶ The value of the input parameter as a basic type.
-
valueReference¶ The value of the input parameter as a basic type.
-
valueSampledData¶ The value of the input parameter as a basic type.
-
valueSignature¶ The value of the input parameter as a basic type.
-
valueHumanName¶ The value of the input parameter as a basic type.
-
valueAddress¶ The value of the input parameter as a basic type.
-
valueContactPoint¶ The value of the input parameter as a basic type.
-
valueTiming¶ The value of the input parameter as a basic type.
-
valueMeta¶ The value of the input parameter as a basic type.
-
valueElementDefinition¶ The value of the input parameter as a basic type.
-
valueContactDetail¶ The value of the input parameter as a basic type.
-
valueContributor¶ The value of the input parameter as a basic type.
-
valueDosage¶ The value of the input parameter as a basic type.
-
valueRelatedArtifact¶ The value of the input parameter as a basic type.
-
valueUsageContext¶ The value of the input parameter as a basic type.
-
valueDataRequirement¶ The value of the input parameter as a basic type.
-
valueParameterDefinition¶ The value of the input parameter as a basic type.
-
valueTriggerDefinition¶ The value of the input parameter as a basic type.
-
-
class
cardea.fhir.Task_Output(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA task to be performed.
-
type¶ The name of the Output parameter.
-
valueBoolean¶ The value of the Output parameter as a basic type.
-
valueInteger¶ The value of the Output parameter as a basic type.
-
valueDecimal¶ The value of the Output parameter as a basic type.
-
valueBase64Binary¶ The value of the Output parameter as a basic type.
-
valueInstant¶ The value of the Output parameter as a basic type.
-
valueString¶ The value of the Output parameter as a basic type.
-
valueUri¶ The value of the Output parameter as a basic type.
-
valueDate¶ The value of the Output parameter as a basic type.
-
valueDateTime¶ The value of the Output parameter as a basic type.
-
valueTime¶ The value of the Output parameter as a basic type.
-
valueCode¶ The value of the Output parameter as a basic type.
-
valueOid¶ The value of the Output parameter as a basic type.
-
valueUuid¶ The value of the Output parameter as a basic type.
-
valueId¶ The value of the Output parameter as a basic type.
-
valueUnsignedInt¶ The value of the Output parameter as a basic type.
-
valuePositiveInt¶ The value of the Output parameter as a basic type.
-
valueMarkdown¶ The value of the Output parameter as a basic type.
-
valueElement¶ The value of the Output parameter as a basic type.
-
valueExtension¶ The value of the Output parameter as a basic type.
-
valueBackboneElement¶ The value of the Output parameter as a basic type.
-
valueNarrative¶ The value of the Output parameter as a basic type.
-
valueAnnotation¶ The value of the Output parameter as a basic type.
-
valueAttachment¶ The value of the Output parameter as a basic type.
-
valueIdentifier¶ The value of the Output parameter as a basic type.
-
valueCodeableConcept¶ The value of the Output parameter as a basic type.
-
valueCoding¶ The value of the Output parameter as a basic type.
-
valueQuantity¶ The value of the Output parameter as a basic type.
-
valueDuration¶ The value of the Output parameter as a basic type.
-
valueSimpleQuantity¶ The value of the Output parameter as a basic type.
-
valueDistance¶ The value of the Output parameter as a basic type.
-
valueCount¶ The value of the Output parameter as a basic type.
-
valueMoney¶ The value of the Output parameter as a basic type.
-
valueAge¶ The value of the Output parameter as a basic type.
-
valueRange¶ The value of the Output parameter as a basic type.
-
valuePeriod¶ The value of the Output parameter as a basic type.
-
valueRatio¶ The value of the Output parameter as a basic type.
-
valueReference¶ The value of the Output parameter as a basic type.
-
valueSampledData¶ The value of the Output parameter as a basic type.
-
valueSignature¶ The value of the Output parameter as a basic type.
-
valueHumanName¶ The value of the Output parameter as a basic type.
-
valueAddress¶ The value of the Output parameter as a basic type.
-
valueContactPoint¶ The value of the Output parameter as a basic type.
-
valueTiming¶ The value of the Output parameter as a basic type.
-
valueMeta¶ The value of the Output parameter as a basic type.
-
valueElementDefinition¶ The value of the Output parameter as a basic type.
-
valueContactDetail¶ The value of the Output parameter as a basic type.
-
valueContributor¶ The value of the Output parameter as a basic type.
-
valueDosage¶ The value of the Output parameter as a basic type.
-
valueRelatedArtifact¶ The value of the Output parameter as a basic type.
-
valueUsageContext¶ The value of the Output parameter as a basic type.
-
valueDataRequirement¶ The value of the Output parameter as a basic type.
-
valueParameterDefinition¶ The value of the Output parameter as a basic type.
-
valueTriggerDefinition¶ The value of the Output parameter as a basic type.
-
-
class
cardea.fhir.TestReport(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
resourceType¶ This is a TestReport resource
-
identifier¶ Identifier for the TestScript assigned for external purposes outside the context of FHIR.
-
name¶ A free text natural language name identifying the executed TestScript.
-
status¶ The current state of this test report.
-
testScript¶ Ideally this is an absolute URL that is used to identify the version-specific TestScript that was executed, matching the TestScript.url.
-
result¶ The overall result from the execution of the TestScript.
-
score¶ The final score (percentage of tests passed) resulting from the execution of the TestScript.
-
tester¶ Name of the tester producing this report (Organization or individual).
-
issued¶ When the TestScript was executed and this TestReport was generated.
-
participant¶ A participant in the test execution, either the execution engine, a client, or a server.
-
setup¶ The results of the series of required setup operations before the tests were executed.
-
test¶ A test executed from the test script.
-
teardown¶ The results of the series of operations required to clean up after the all the tests were executed (successfully or otherwise).
-
-
class
cardea.fhir.TestReport_Participant(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
type¶ The type of participant.
-
uri¶ The uri of the participant. An absolute URL is preferred.
-
display¶ The display name of the participant.
-
-
class
cardea.fhir.TestReport_Setup(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
action¶ Action would contain either an operation or an assertion.
-
-
class
cardea.fhir.TestReport_Action(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
operation¶ The operation performed.
-
assert¶ The results of the assertion performed on the previous operations.
-
-
class
cardea.fhir.TestReport_Operation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
result¶ The result of this operation.
-
message¶ An explanatory message associated with the result.
-
detail¶ A link to further details on the result.
-
-
class
cardea.fhir.TestReport_Assert(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
result¶ The result of this assertion.
-
message¶ An explanatory message associated with the result.
-
detail¶ A link to further details on the result.
-
-
class
cardea.fhir.TestReport_Test(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
name¶ The name of this test used for tracking/logging purposes by test engines.
-
description¶ A short description of the test used by test engines for tracking and reporting purposes.
-
action¶ Action would contain either an operation or an assertion.
-
-
class
cardea.fhir.TestReport_Action1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
operation¶ An operation would involve a REST request to a server.
-
assert¶ The results of the assertion performed on the previous operations.
-
-
class
cardea.fhir.TestReport_Teardown(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
action¶ The teardown action will only contain an operation.
-
-
class
cardea.fhir.TestReport_Action2(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA summary of information based on the results of executing a TestScript.
-
operation¶ An operation would involve a REST request to a server.
-
-
class
cardea.fhir.TestScript(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
resourceType¶ This is a TestScript resource
-
url¶ An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this test script is (or will be) published. The URL SHOULD include the major version of the test script. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the test script.
-
status¶ The status of this test script. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the test script was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes.
-
publisher¶ The name of the individual or organization that published the test script.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the test script from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate test script instances.
-
jurisdiction¶ A legal or geographic region in which the test script is intended to be used.
-
purpose¶ Explaination of why this test script is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.
-
origin¶ An abstract server used in operations within this test script in the origin element.
-
destination¶ An abstract server used in operations within this test script in the destination element.
-
metadata¶ The required capability must exist and are assumed to function correctly on the FHIR server being tested.
-
fixture¶ Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.
-
profile¶ Reference to the profile to be used for validation.
-
variable¶ Variable is set based either on element value in response body or on header field value in the response headers.
-
rule¶ Assert rule to be used in one or more asserts within the test script.
-
ruleset¶ Contains one or more rules. Offers a way to group rules so assertions could reference the group of rules and have them all applied.
-
setup¶ A series of required setup operations before tests are executed.
-
test¶ A test in this script.
-
teardown¶ A series of operations required to clean up after the all the tests are executed (successfully or otherwise).
-
-
class
cardea.fhir.TestScript_Origin(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
index¶ Abstract name given to an origin server in this test script. The name is provided as a number starting at 1.
-
profile¶ The type of origin profile the test system supports.
-
-
class
cardea.fhir.TestScript_Destination(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
index¶ Abstract name given to a destination server in this test script. The name is provided as a number starting at 1.
-
profile¶ The type of destination profile the test system supports.
-
-
class
cardea.fhir.TestScript_Metadata(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
link¶ A link to the FHIR specification that this test is covering.
-
capability¶ Capabilities that must exist and are assumed to function correctly on the FHIR server being tested.
-
-
class
cardea.fhir.TestScript_Link(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
url¶ URL to a particular requirement or feature within the FHIR specification.
-
description¶ Short description of the link.
-
-
class
cardea.fhir.TestScript_Capability(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
required¶ Whether or not the test execution will require the given capabilities of the server in order for this test script to execute.
-
validated¶ Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute.
-
description¶ Description of the capabilities that this test script is requiring the server to support.
-
origin¶ Which origin server these requirements apply to.
-
destination¶ Which server these requirements apply to.
-
link¶ Links to the FHIR specification that describes this interaction and the resources involved in more detail.
-
capabilities¶ Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped.
-
-
class
cardea.fhir.TestScript_Fixture(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
autocreate¶ Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section.
-
autodelete¶ Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section.
-
resource¶ Reference to the resource (containing the contents of the resource needed for operations).
-
-
class
cardea.fhir.TestScript_Variable(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
name¶ Descriptive name for this variable.
-
defaultValue¶ A default, hard-coded, or user-defined value for this variable.
-
description¶ A free text natural language description of the variable and its purpose.
-
expression¶ The fluentpath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
-
headerField¶ Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.
-
hint¶ Displayable text string with hint help information to the user when entering a default value.
-
path¶ XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
-
sourceId¶ Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.
-
-
class
cardea.fhir.TestScript_Rule(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
resource¶ Reference to the resource (containing the contents of the rule needed for assertions).
-
param¶ Each rule template can take one or more parameters for rule evaluation.
-
-
class
cardea.fhir.TestScript_Param(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
name¶ Descriptive name for this parameter that matches the external assert rule parameter name.
-
value¶ The explicit or dynamic value for the parameter that will be passed on to the external rule template.
-
-
class
cardea.fhir.TestScript_Ruleset(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
resource¶ Reference to the resource (containing the contents of the ruleset needed for assertions).
-
rule¶ The referenced rule within the external ruleset template.
-
-
class
cardea.fhir.TestScript_Rule1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
ruleId¶ Id of the referenced rule within the external ruleset template.
-
param¶ Each rule template can take one or more parameters for rule evaluation.
-
-
class
cardea.fhir.TestScript_Param1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
name¶ Descriptive name for this parameter that matches the external assert ruleset rule parameter name.
-
value¶ The value for the parameter that will be passed on to the external ruleset rule template.
-
-
class
cardea.fhir.TestScript_Setup(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
action¶ Action would contain either an operation or an assertion.
-
-
class
cardea.fhir.TestScript_Action(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
operation¶ The operation to perform.
-
assert¶ Evaluates the results of previous operations to determine if the server under test behaves appropriately.
-
-
class
cardea.fhir.TestScript_Operation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
type¶ Server interaction or operation type.
-
resource¶ The type of the resource. See http://build.fhir.org/resourcelist.html.
-
label¶ The label would be used for tracking/logging purposes by test engines.
-
description¶ The description would be used by test engines for tracking and reporting purposes.
-
accept¶ The content-type or mime-type to use for RESTful operation in the ‘Accept’ header.
-
contentType¶ The content-type or mime-type to use for RESTful operation in the ‘Content-Type’ header.
-
destination¶ The server where the request message is destined for. Must be one of the server numbers listed in TestScript.destination section.
-
encodeRequestUrl¶ Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths.
-
origin¶ The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.
-
params¶ Path plus parameters after [type]. Used to set parts of the request URL explicitly.
-
requestHeader¶ Header elements would be used to set HTTP headers.
-
requestId¶ The fixture id (maybe new) to map to the request.
-
responseId¶ The fixture id (maybe new) to map to the response.
-
sourceId¶ The id of the fixture used as the body of a PUT or POST request.
-
targetId¶ Id of fixture used for extracting the [id], [type], and [vid] for GET requests.
-
url¶ Complete request URL.
-
-
class
cardea.fhir.TestScript_RequestHeader(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
field¶ The HTTP header field e.g. “Accept”.
-
value¶ The value of the header e.g. “application/fhir+xml”.
-
-
class
cardea.fhir.TestScript_Assert(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
label¶ The label would be used for tracking/logging purposes by test engines.
-
description¶ The description would be used by test engines for tracking and reporting purposes.
-
direction¶ The direction to use for the assertion.
-
compareToSourceId¶ Id of the source fixture used as the contents to be evaluated by either the “source/expression” or “sourceId/path” definition.
-
compareToSourceExpression¶ The fluentpath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
-
compareToSourcePath¶ XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
-
contentType¶ The content-type or mime-type to use for RESTful operation in the ‘Content-Type’ header.
-
expression¶ The fluentpath expression to be evaluated against the request or response message contents - HTTP headers and payload.
-
headerField¶ The HTTP header field name e.g. ‘Location’.
-
minimumId¶ The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.
Whether or not the test execution performs validation on the bundle navigation links.
-
operator¶ The operator type defines the conditional behavior of the assert. If not defined, the default is equals.
-
path¶ The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.
-
requestMethod¶ The request method or HTTP operation code to compare against that used by the client system under test.
-
requestURL¶ The value to use in a comparison against the request URL path string.
-
resource¶ The type of the resource. See http://build.fhir.org/resourcelist.html.
-
response¶ okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable.
-
responseCode¶ The value of the HTTP response code to be tested.
-
rule¶ The TestScript.rule this assert will evaluate.
-
ruleset¶ The TestScript.ruleset this assert will evaluate.
-
sourceId¶ Fixture to evaluate the XPath/JSONPath expression or the headerField against.
-
validateProfileId¶ The ID of the Profile to validate against.
-
value¶ The value to compare to.
-
warningOnly¶ Whether or not the test execution will produce a warning only on error for this assert.
-
-
class
cardea.fhir.TestScript_Rule2(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
ruleId¶ The TestScript.rule id value this assert will evaluate.
-
param¶ Each rule template can take one or more parameters for rule evaluation.
-
-
class
cardea.fhir.TestScript_Param2(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
name¶ Descriptive name for this parameter that matches the external assert rule parameter name.
-
value¶ The value for the parameter that will be passed on to the external rule template.
-
-
class
cardea.fhir.TestScript_Ruleset1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
rulesetId¶ The TestScript.ruleset id value this assert will evaluate.
-
rule¶ The referenced rule within the external ruleset template.
-
-
class
cardea.fhir.TestScript_Rule3(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
ruleId¶ Id of the referenced rule within the external ruleset template.
-
param¶ Each rule template can take one or more parameters for rule evaluation.
-
-
class
cardea.fhir.TestScript_Param3(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
name¶ Descriptive name for this parameter that matches the external assert ruleset rule parameter name.
-
value¶ The value for the parameter that will be passed on to the external ruleset rule template.
-
-
class
cardea.fhir.TestScript_Test(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
name¶ The name of this test used for tracking/logging purposes by test engines.
-
description¶ A short description of the test used by test engines for tracking and reporting purposes.
-
action¶ Action would contain either an operation or an assertion.
-
-
class
cardea.fhir.TestScript_Action1(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
operation¶ An operation would involve a REST request to a server.
-
assert¶ Evaluates the results of previous operations to determine if the server under test behaves appropriately.
-
-
class
cardea.fhir.TestScript_Teardown(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
action¶ The teardown action will only contain an operation.
-
-
class
cardea.fhir.TestScript_Action2(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA structured set of tests against a FHIR server implementation to determine compliance against the FHIR specification.
-
operation¶ An operation would involve a REST request to a server.
-
-
class
cardea.fhir.Timing(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseSpecifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
-
event¶ Identifies specific times when the event occurs.
-
repeat¶ A set of rules that describe when the event is scheduled.
-
code¶ A code for the timing schedule. Some codes such as BID are ubiquitous, but many institutions define their own additional codes. If a code is provided, the code is understood to be a complete statement of whatever is specified in the structured timing data, and either the code or the data may be used to interpret the Timing, with the exception that .repeat.bounds still applies over the code (and is not contained in the code).
-
-
class
cardea.fhir.Timing_Repeat(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseSpecifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.
-
boundsDuration¶ Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
-
boundsRange¶ Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
-
boundsPeriod¶ Either a duration for the length of the timing schedule, a range of possible length, or outer bounds for start and/or end limits of the timing schedule.
-
count¶ A total count of the desired number of repetitions.
-
countMax¶ A maximum value for the count of the desired repetitions (e.g. do something 6-8 times).
-
duration¶ How long this thing happens for when it happens.
-
durationMax¶ The upper limit of how long this thing happens for when it happens.
-
durationUnit¶ The units of time for the duration, in UCUM units.
-
frequency¶ The number of times to repeat the action within the specified period / period range (i.e. both period and periodMax provided).
-
frequencyMax¶ If present, indicates that the frequency is a range - so to repeat between [frequency] and [frequencyMax] times within the period or period range.
-
period¶ Indicates the duration of time over which repetitions are to occur; e.g. to express “3 times per day”, 3 would be the frequency and “1 day” would be the period.
-
periodMax¶ If present, indicates that the period is a range from [period] to [periodMax], allowing expressing concepts such as “do this once every 3-5 days.
-
periodUnit¶ The units of time for the period in UCUM units.
-
dayOfWeek¶ If one or more days of week is provided, then the action happens only on the specified day(s).
-
timeOfDay¶ Specified time of day for action to take place.
-
when¶ Real world events that the occurrence of the event should be tied to.
-
offset¶ The number of minutes from the event. If the event code does not indicate whether the minutes is before or after the event, then the offset is assumed to be after the event.
-
-
class
cardea.fhir.TriggerDefinition(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA description of a triggering event.
-
type¶ The type of triggering event.
-
eventName¶ The name of the event (if this is a named-event trigger).
-
eventTimingTiming¶ The timing of the event (if this is a period trigger).
-
eventTimingReference¶ The timing of the event (if this is a period trigger).
-
eventTimingDate¶ The timing of the event (if this is a period trigger).
-
eventTimingDateTime¶ The timing of the event (if this is a period trigger).
-
eventData¶ The triggering data of the event (if this is a data trigger).
-
-
class
cardea.fhir.UsageContext(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseSpecifies clinical/business/etc metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).
-
code¶ A code that identifies the type of context being specified by this usage context.
-
valueCodeableConcept¶ A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
-
valueQuantity¶ A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
-
valueRange¶ A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
-
-
class
cardea.fhir.ValueSet(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
resourceType¶ This is a ValueSet resource
-
url¶ An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published. The URL SHOULD include the major version of the value set. For more information see [Technical and Business Versions](resource.html#versions).
-
identifier¶ A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version¶ The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
name¶ A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title¶ A short, descriptive, user-friendly title for the value set.
-
status¶ The status of this value set. Enables tracking the life-cycle of the content.
-
experimental¶ A boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
date¶ The date (and optionally time) when the value set was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the value set changes. (e.g. the ‘content logical definition’).
-
publisher¶ The name of the individual or organization that published the value set.
-
contact¶ Contact details to assist a user in finding and communicating with the publisher.
-
description¶ A free text natural language description of the value set from a consumer’s perspective.
-
useContext¶ The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate value set instances.
-
jurisdiction¶ A legal or geographic region in which the value set is intended to be used.
-
immutable¶ If this is set to ‘true’, then no new versions of the content logical definition can be created. Note: Other metadata might still change.
-
purpose¶ Explaination of why this value set is needed and why it has been designed as it has.
-
copyright¶ A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
-
extensible¶ Whether this is intended to be used with an extensible binding or not.
-
compose¶ A set of criteria that define the content logical definition of the value set by including or excluding codes from outside this value set. This I also known as the “Content Logical Definition” (CLD).
-
expansion¶ A value set can also be “expanded”, where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.
-
-
class
cardea.fhir.ValueSet_Compose(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
lockedDate¶ If a locked date is defined, then the Content Logical Definition must be evaluated using the current version as of the locked date for referenced code system(s) and value set instances where ValueSet.compose.include.version is not defined.
-
inactive¶ Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable ExpansionProfile (but generally, inactive codes would be expected to be included).
-
include¶ Include one or more codes from a code system or other value set(s).
-
exclude¶ Exclude one or more codes from the value set based on code system filters and/or other value sets.
-
-
class
cardea.fhir.ValueSet_Include(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
system¶ An absolute URI which is the code system from which the selected codes come from.
-
version¶ The version of the code system that the codes are selected from.
-
concept¶ Specifies a concept to be included or excluded.
-
filter¶ Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true.
-
valueSet¶ Selects concepts found in this value set. This is an absolute URI that is a reference to ValueSet.url.
-
-
class
cardea.fhir.ValueSet_Concept(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
code¶ Specifies a code for the concept to be included or excluded.
-
display¶ The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.
-
designation¶ Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.
-
-
class
cardea.fhir.ValueSet_Designation(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
language¶ The language this designation is defined for.
-
use¶ A code that details how this designation would be used.
-
value¶ The text value for this designation.
-
-
class
cardea.fhir.ValueSet_Filter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
property¶ A code that identifies a property defined in the code system.
-
op¶ The kind of operation to perform as a part of the filter criteria.
-
value¶ The match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value when the operation is ‘regex’, or one of the values (true and false), when the operation is ‘exists’.
-
-
class
cardea.fhir.ValueSet_Expansion(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
identifier¶ An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so.
-
timestamp¶ The time at which the expansion was produced by the expanding system.
-
total¶ The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.
-
offset¶ If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL not be present.
-
parameter¶ A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.
-
contains¶ The codes that are contained in the value set expansion.
-
-
class
cardea.fhir.ValueSet_Parameter(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
name¶ The name of the parameter.
-
valueString¶ The value of the parameter.
-
valueBoolean¶ The value of the parameter.
-
valueInteger¶ The value of the parameter.
-
valueDecimal¶ The value of the parameter.
-
valueUri¶ The value of the parameter.
-
valueCode¶ The value of the parameter.
-
-
class
cardea.fhir.ValueSet_Contains(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseA value set specifies a set of codes drawn from one or more code systems.
-
system¶ An absolute URI which is the code system in which the code for this item in the expansion is defined.
-
abstract¶ If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.
-
inactive¶ If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data.
-
version¶ The version of this code system that defined this code and/or display. This should only be used with code systems that do not enforce concept permanence.
-
code¶ The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.
-
display¶ The recommended display for this item in the expansion.
-
designation¶ Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.
-
contains¶ Other codes and entries contained under this entry in the hierarchy.
-
-
class
cardea.fhir.VisionPrescription(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn authorization for the supply of glasses and/or contact lenses to a patient.
-
resourceType¶ This is a VisionPrescription resource
-
identifier¶ Business identifier which may be used by other parties to reference or identify the prescription.
-
status¶ The status of the resource instance.
-
patient¶ A link to a resource representing the person to whom the vision products will be supplied.
-
encounter¶ A link to a resource that identifies the particular occurrence of contact between patient and health care provider.
-
dateWritten¶ The date (and perhaps time) when the prescription was written.
-
prescriber¶ The healthcare professional responsible for authorizing the prescription.
-
reasonCodeableConcept¶ Can be the reason or the indication for writing the prescription.
-
reasonReference¶ Can be the reason or the indication for writing the prescription.
-
dispense¶ Deals with details of the dispense part of the supply specification.
-
-
class
cardea.fhir.VisionPrescription_Dispense(dict_values=None)[source]¶ Bases:
cardea.fhir.fhirbase.fhirbaseAn authorization for the supply of glasses and/or contact lenses to a patient.
-
product¶ Identifies the type of vision correction product which is required for the patient.
-
eye¶ The eye for which the lens applies.
-
sphere¶ Lens power measured in diopters (0.25 units).
-
cylinder¶ Power adjustment for astigmatism measured in diopters (0.25 units).
-
axis¶ Adjustment for astigmatism measured in integer degrees.
-
prism¶ Amount of prism to compensate for eye alignment in fractional units.
-
base¶ The relative base, or reference lens edge, for the prism.
-
add¶ Power adjustment for multifocal lenses measured in diopters (0.25 units).
-
power¶ Contact lens power measured in diopters (0.25 units).
-
backCurve¶ Back curvature measured in millimeters.
-
diameter¶ Contact lens diameter measured in millimeters.
-
duration¶ The recommended maximum wear period for the lens.
-
color¶ Special color or pattern.
-
brand¶ Brand recommendations or restrictions.
-
note¶ Notes for special requirements such as coatings and lens materials.
-